AdvertiserId

• Type: int32
• Required: Yes
• Description: The ID of the Advertiser.

pageSize

• Type: int32
• Description: The size of the page to be returned.

page

• Type: int32
• Description: The page number to be returned.

200 Response from the List Advertiser Segments endpoint.

• Type: object

Response Structure

• page: int32 (required) - The page number to be returned.
• Items: array of objects (required) - The items on the page.

Items Structure

• Id: int32 (required) - The ID of the Advertiser Segment.
• AdvertiserId: string (required) - The ID of the Advertiser.
• SegmentId: string (required) - The ID of the Segment.
• Segment: object (required) - Segment object.

Segment Structure

• pageSize: int32 - The size of the page to be returned.
• totalPages: int32 - The total number of pages.
• totalItems: int32 - The total number of items.

400 An error signifying that the client has issued a bad request

Shell Example:

curl --request GET \
     --url https://api.kevel.co/v1/advertiser/111111/segment \
     --header 'accept: application/json'

Example JSON Response:

{
  "page": 1,
  "items": [
    {
      "Id": 56789,
      "AdvertiserId": 111111,
      "SegmentId": 222222,
      "Segment": {
        "Id": 222222,
        "Source": "audience",
        "Name": "best customers",
        "Reach": {
          "all_time": 3187463,
          "28d": 387434
        },
        "Description": "top 1% spenders in the last 30 days.",
        "Category": "CRM"
      }
    }
  ],
  "pageSize": 1,
  "totalPages": 1,
  "totalItems": 1
}