Get Entity Counts

Why Get Entity Counts

You may wish to retrieve a list of entities that you are being billed for to verify you are not hitting any contractual limits and reconcile with external systems. The Get Entity Counts endpoint allows you to see how many entities you have by type as of a given date.

Definition of Billable Entities

"Billable" entities are reported based on the "armed" status (ie eligible to serve) of related entities. Kevel uses the following definitions for armed entities:

• Armed Advertiser: Active, not deleted
• Armed Campaign: Active, not deleted, not archived
• Armed Flight: Active, not deleted, not archived, not ended
• Armed Ad: Active, not deleted
• Armed Site: Not deleted
• Armed Zone: Not deleted
• Armed Creative: Active, not deleted
• Armed Channel: Not deleted

Following from the above, Kevel uses the following definitions for billable entities:

• Billable Advertiser: Armed, has at least one armed campaign
• Billable Campaign: Armed, in an armed advertiser, has at least one armed flight
• Billable Flight: Armed, in an armed campaign, has at least one armed ad
• Billable Ad: Armed, in an armed flight
• Billable Site: Armed site
• Billable Zone: Armed, in an armed site if it has one
• Billable Creative: Armed, in an armed advertiser
• Billable Channel: Armed channel

Get the Entity Counts

Get the entity counts for a specific date within the last 60 days by entering a date in the format YYYY-MM-DD. If no date is provided, the most recent entity count will be returned.

Example Response

{
  "BillableZones": 1,
  "BillableAds": 8,
  "BillableAdvertisers": 1,
  "BillableChannels": 5,
  "EffectiveAt": "2023-08-09T00:00:00",
  "NetworkId": 10649,
  "BillableSites": 5,
  "BillableFlights": 1,
  "BillableCreatives": 17,
  "BillableCampaigns": 1
}

Shell Command Example

curl -X GET -H "X-Adzerk-ApiKey:$ADZERK_API_KEY" "https://api.kevel.co/v1/entitycounts?date=2023-08-08"