Promotional API Queries
Available for Publishers and Advertisers All queries listed on this page are read-only and accessible to both user types.
Query: promotionalProperties
promotionalPropertiesReturns: PromotionalProperties!
Returns the details of one or more promotional properties, filtered according to the supplied arguments.
| Argument | Type | Description |
|---|---|---|
publisherId | ID! | Required. The publisher's CID. |
limit | Int | Maximum number of results to return. Default is 10; maximum is 100. |
offset | Int | Record number of the first result to display. Use with limit to paginate. For example, setting offset to 10 displays results starting with the tenth record. |
search | String | Keyword search across property name, property ID, and description. |
status | PromotionalPropertyStatus | Filters results to properties with this status. |
Query: promotionalPropertiesByIds
promotionalPropertiesByIdsReturns: [PromotionalProperty!]!
Returns a list of promotional properties by their PIDs.
| Argument | Type | Description |
|---|---|---|
ids | [ID!]! | Required. Comma-separated list of property IDs. Maximum 100 IDs per request. |
Query: promotionalProperty
promotionalPropertyReturns: PromotionalProperty
Returns a single promotional property by its ID.
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. A promotional property ID. |
Query: distinctPropertyValues
distinctPropertyValuesReturns: DistinctPropertyValues
Returns an object containing the list of a publisher's unique promotional models and property types. Useful for building filter UIs or summarizing a publisher's property portfolio.
| Argument | Type | Description |
|---|---|---|
publisherId | ID! | Required. The publisher's CID. |
Updated 9 days ago