Skip to main content
GET
List stock alert firings

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Path Parameters

voucherSetId
integer<uint64>
required

Numeric id (voucherSetId). A non-numeric id is a 400 data-failed-validation; an unknown id or one of another partner is a 404. Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Query Parameters

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

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

Required range: 1 <= x <= 100
sort
string
default:-firedAt

One sort field; prefix - for descending (sort=field or sort=-field); id is appended as tie-breaker. Another value is a 400 data-failed-validation with the constraint invalid-sort. Default -firedAt.

Example:

"-firedAt"

filter[firedAt][gte]
string<date-time>

Filter on firedAt (greater than or equal).

filter[firedAt][lt]
string<date-time>

Filter on firedAt (less than).

Response

A page of results.

Page envelope of StockAlertFiring.

data
object
required

Page body.