Count lookups over time
GEThttps://api.checkslip.com/api/slips/counts
API key
Lookups of this account per time bucket, split by outcome, for a chart. Counted by the time of the lookup (checked_at), the same axis as the lookup history table; Credit usage counts by the time the credit was settled, so the two do not always match. bucket is MINUTE, FIVE_MINUTE, FIFTEEN_MINUTE, HOUR, THREE_HOUR, SIX_HOUR, TWELVE_HOUR or DAY. At most 1,440 points per call; a window too wide for the bucket answers 400. Only time and outcome filter the counts; any other filter you send is listed in filters_ignored. Counts trail the table by about 2 minutes, see as_of. No credit is used. Needs an API key with slip:read.
Parameters
| Field | In | Type | Required |
|---|---|---|---|
from | query | string (date-time) | yes |
to | query | string (date-time) | yes |
bucket | query | MINUTE | FIVE_MINUTE | FIFTEEN_MINUTE | HOUR | THREE_HOUR | SIX_HOUR | TWELVE_HOUR | DAY | yes |
outcome | query | FOUND | NOT_FOUND | DUPLICATE | PENDING | UNAVAILABLE | INVALID_QR | INVALID_FILE | QR_TAMPERED | TOO_OLD[] | no |
outcome_not | query | FOUND | NOT_FOUND | DUPLICATE | PENDING | UNAVAILABLE | INVALID_QR | INVALID_FILE | QR_TAMPERED | TOO_OLD[] | no |
q | query | string | no |
trans_ref | query | string | no |
sender_bank | query | string | no |
api_key | query | string | no |
after | query | string | no |
charged | query | string[] | no |
free_reason | query | string[] | no |
Responses
200 application/json
| Field | Type | Required |
|---|---|---|
bucket | MINUTE | FIVE_MINUTE | FIFTEEN_MINUTE | HOUR | THREE_HOUR | SIX_HOUR | TWELVE_HOUR | DAY | yes |
as_of | string (date-time) | yes |
filters_applied | from | to | outcome | outcome_not[] | yes |
filters_ignored | q | trans_ref | sender_bank | api_key | after | charged | free_reason[] | yes |
series | object[] | yes |
series[].start | string (date-time) | yes |
series[].counts | object | yes |
Possible errors
400401403429
An error as Problem Details. All codes are listed at Error codes