Skip to main content
GET
Get entity statistics

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Query Parameters

granularity
enum<string>
default:month

month or day (default month).

Available options:
month,
day
page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Items per page, 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string

One sort field; prefix - for descending (sort=field or sort=-field). Allowed: period. Default period. The server appends id as a tie-breaker.

Example:

"period"

filter[period][gte]
string

Period YYYY-MM (month granularity) or YYYY-MM-DD (day granularity). (greater than or equal).

filter[period][gt]
string

Period YYYY-MM (month granularity) or YYYY-MM-DD (day granularity). (greater than).

filter[period][lte]
string

Period YYYY-MM (month granularity) or YYYY-MM-DD (day granularity). (less than or equal).

filter[period][lt]
string

Period YYYY-MM (month granularity) or YYYY-MM-DD (day granularity). (less than).

filter[providerPartnerId]
integer

Provider id (equals).

Required range: x >= 0
filter[providerPartnerId][in]
string

Provider id (one of (comma-separated)). Comma-separated values.

filter[voucherSetId]
integer

Voucher set id (equals).

Required range: x >= 0
filter[voucherSetId][in]
string

Voucher set id (one of (comma-separated)). Comma-separated values.

filter[channel]
enum<string>

Channel (equals).

Available options:
api,
dashboard,
redemption-link,
import
filter[channel][in]
string

Channel (one of (comma-separated)). Comma-separated values.

Response

OK

Page envelope of EntityStatsRow items.

data
object
required

The page.