Skip to content

Get Ad Count for State

This is the primary endpoint for retrieving the counts of ads of various states.

1
GET /customers/<token>/adcount

Input Parameters

Path Param Type Required Description
token string Required The security token for the customer
Query Param Type Required Description
status int Required A bitwise concatenation of the various AdStatus desired. For example if ads with status 2 or 16 are desired, the value specified here will be 18.
includeParked boolean Optional If true, only parked ads are counted. If false, only ads which have not been parked are counted. If not specified, ads in both states are counted.

Output

This endpoint returns an AdCount object.

Property Type Description
count int The number of ads for this count

Example

This example will return the count of ads which are parked and which are in either the redeemed (16), activated (4), or served (2) status.

Request

1
GET /api/v1/customers/C1FA3C38-1B28-4B54-A2F8-E577FFEEF9F5/adcount/?includeParked=true&status=22

Response

1
2
3
{
   "count":21
}