Skip to main content
GET
Get a creative's counts

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Path Parameters

creativeId
string<cuid2>
required

Creative identifier.

Query Parameters

from
string<date>

First UTC day, inclusive (YYYY-MM-DD). Defaults to 29 days before to.

to
string<date>

Last UTC day, inclusive (YYYY-MM-DD). Defaults to today, in UTC.

groupBy
enum<string>

Adds a breakdown: page adds pages (host + path), device adds devices (phone, tablet, desktop). Omit for totals and days only.

Available options:
page,
device

Response

Counts retrieved successfully

data
object
required

A creative's Impressions and Clicks over a range of UTC days. An Impression is one page view on which the creative showed (showing it again on the same page adds none; a new page, a single-page-app route change included, does). A Click is one press that opened its Destination; dismissing a banner, or pressing while its survey is already open, isn't one. clickRate is Clicks divided by Impressions, as a fraction (0.05 is 5 %), or null without Impressions.

totals and every breakdown count the same events, so days, pages and devices each add up to totals.