Skip to main content
GET
Period summary for BI integration

Authorizations

X-API-Key
string
header
required

Query Parameters

organization_id
string<shortuuid>
required

UUID of the organization to query (caller must be a member).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
days
integer
default:30

Window size in days, ending now. Clamped server-side to the organization's actual raw-event retention — the response may cover a shorter window than requested.

Required range: 1 <= x <= 365

Response

OK

Period summary — the same payload the Overview tab and PDF export render.

Backs GET /exports/overview, the JSON counterpart to the Exports tab's PDF download, for customers integrating with their own BI tools.

days
integer
required

Window size in days actually used (the requested value, clamped if needed).

period
PeriodOut · object
required

Window covered by this summary.

Example:
resolves
MetricDeltaOut · object
required

Total resolves this period vs. the previous period.

Example:
page_visits
MetricDeltaOut · object
required

Total page visits this period vs. the previous period.

Example:
conversion
ConversionOut · object
required

Resolve-to-visit conversion rate.

Example:
top_gtins
TopGtinOut · object[]
required

Top 5 GTINs by resolve volume.

countries
CountryCountOut · object[]
required

Resolve counts by country, descending.

country_count
integer
required

Number of distinct countries with at least one resolve.

Required range: x >= 0