Retrieve campaign timetables (dayparting).

Retrieve the dayparting configuration for a campaign.

Returns all configured timetables for the campaign, ordered by day of week. If no timetables are configured, returns an empty list.

HOUR SEMANTICS:

• start_hour: Campaign starts at this hour (inclusive, 0-23)
• end_hour: Campaign stops at this hour (exclusive, 1-24)
• Example: start_hour=9, end_hour=17 means runs from 9:00 AM to 5:00 PM.

GET /public/v1/campaign-service/campaigns/{campaign-id}/timetables

Retrieve campaign timetables (dayparting).

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/timetables \
  --header 'Authorization: Bearer <token>'

200

{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timetables": [
    {
      "isActive": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "startHour": 0,
      "endHour": 24
    }
  ]
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

campaign-id · string<uuid> · required

The ID of the campaign.

Query Parameters

vendor_id · string · required

The ID of the vendor.

Minimum string length: 1

Response

200

application/json

Successful Response

The schedule for the campaign.

campaignId · string<uuid> · required

The ID of the campaign.

timetables · CampaignTimeTableResponse · object[] · required

The schedule for the campaign.

Show child attributes