Get Ad Counts for all States
This endpoint gets the counts of ads in several different states, allowing the API consumer to make one request instead of several requests to the /adcount endpoint.
| GET /customers/<token>/adcounts
|
| Path Param |
Type |
Required |
Description |
| token |
string |
Required |
The security token for the customer |
Output
This endpoint returns an AdCounts object with the count data.
| Property |
Type |
Description |
| active |
AdCount |
The number of ads that are active and neither expired, redeemed, nor parked |
| activeParked |
AdCount |
The number of ads that are active, parked, and neither expired nor redeemed |
| notActiveNew |
AdCount |
The number of ads that are neither active, served, nor expired (i.e. new offers) |
| notActiveServed |
AdCount |
The number of ads that are not active nor expired but have been served |
| notActiveExpired |
AdCount |
The number of ads that are not active and are expired. Excludes parked ads |
| notActiveParked |
AdCount |
The number of ads that are parked but neither active not expired |
Example
Request
| GET /api/v1/customers/C1FA3C38-1B28-4B54-A2F8-E577FFEEF9F5/adcounts
|