Skip to content

SegmentAdAudience ​

Type: schema

TypeScript Definition ​

typescript
SegmentAdAudience: {{
            id?: $Read<string>;
            name: string;
            description?: string | null;
            audience_match_field?: string | null;
            service_provider_id: string;
            service_provider_name?: $Read<string>;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
            /**
             * @description default status = pending
             * @enum {unknown}
             */
            last_synced_status?: $Read<"success" | "failed" | "pending">;
            /** Format: date-time */
            last_synced_at?: $Read<string>;
            total_people_synced?: $Read<number>;
        };
        /** SegmentInfo */
}

OpenAPI Schema ​

json
{
  "title": "SegmentAdAudience",
  "type": "object",
  "required": [
    "name",
    "service_provider_id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "audience_match_field": {
      "type": [
        "string",
        "null"
      ]
    },
    "service_provider_id": {
      "type": "string"
    },
    "service_provider_name": {
      "type": "string",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "last_synced_status": {
      "description": "default status = pending",
      "enum": [
        "success",
        "failed",
        "pending"
      ],
      "readOnly": true
    },
    "last_synced_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "total_people_synced": {
      "type": "integer",
      "readOnly": true
    }
  },
  "x-tags": [
    "Segments"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: