Skip to main content
GET
/
advertisers
/
{advertiserId}
/
events
/
summary
Get event summary
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/events/summary \
  --header 'Authorization: Bearer <token>'
{
  "periodStart": "2026-03-27T14:00:00.000Z",
  "periodEnd": "2026-03-27T15:00:00.000Z",
  "entries": [
    {
      "eventHour": "2026-03-27T14:00:00.000Z",
      "eventType": "conversion",
      "eventCount": 1500
    }
  ],
  "totalEventCount": 5000
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
advertiserId
string
required

Unique identifier for the advertiser

Minimum string length: 1
Example:

"12345"

Query Parameters

​
eventType
enum<string>

Filter by event type. When omitted, returns all event types.

Available options:
conversion,
click,
impression,
measurement,
mmp
Example:

"impression"

​
startHour
string

Start of the query range (inclusive). Must be hour-aligned. Defaults to the start of the last completed UTC hour.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:00:00(Z|[+-]\d{2}:\d{2})$
Example:

"2026-03-27T14:00:00Z"

​
endHour
string

End of the query range (exclusive). Must be hour-aligned. Defaults to the end of the last completed UTC hour.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:00:00(Z|[+-]\d{2}:\d{2})$
Example:

"2026-03-27T15:00:00Z"

Response

Get event summary

Response containing hourly-aggregated event counts for an advertiser

​
periodStart
string<date-time>
required

Start of the queried period (inclusive, ISO 8601)

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2026-03-27T14:00:00.000Z"

​
periodEnd
string<date-time>
required

End of the queried period (exclusive, ISO 8601)

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2026-03-27T15:00:00.000Z"

​
entries
object[]
required

Aggregated event entries within the queried period

​
totalEventCount
integer
required

Sum of all event counts across all entries

Required range: 0 <= x <= 9007199254740991
Example:

5000