ads
promoted

List all promoteds

Changed on
get/ads/{connection_id}/promoted

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/ads/{connection_id}/promoted
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

org_idstring

The org ID to filter by (reference to AdsOrganization)

typestring
fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring required
namestring
type'PAGE_ID' | 'APP_ID' | 'STORE_URL' | 'PIXEL_ID' | 'CUSTOM_CONVERSION_ID' | 'CATALOG_ID' | 'PRODUCT_SET_ID' | 'PRIORITIZED_SET_ID' | 'EVENT_ID' | 'OFFER_ID' | 'LEAD_FORM_ID' | 'MESSAGING_CHANNEL_ID' | 'PRODUCT_ID' | 'TWEET_ID' | 'AD_GROUP_TYPE' required

Promoted entity types for ads_promoted list endpoint

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status