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

FieldInTypeRequired
fromquerystring (date-time)yes
toquerystring (date-time)yes
bucketqueryMINUTE | FIVE_MINUTE | FIFTEEN_MINUTE | HOUR | THREE_HOUR | SIX_HOUR | TWELVE_HOUR | DAYyes
outcomequeryFOUND | NOT_FOUND | DUPLICATE | PENDING | UNAVAILABLE | INVALID_QR | INVALID_FILE | QR_TAMPERED | TOO_OLD[]no
outcome_notqueryFOUND | NOT_FOUND | DUPLICATE | PENDING | UNAVAILABLE | INVALID_QR | INVALID_FILE | QR_TAMPERED | TOO_OLD[]no
qquerystringno
trans_refquerystringno
sender_bankquerystringno
api_keyquerystringno
afterquerystringno
chargedquerystring[]no
free_reasonquerystring[]no

Responses

200 application/json

FieldTypeRequired
bucketMINUTE | FIVE_MINUTE | FIFTEEN_MINUTE | HOUR | THREE_HOUR | SIX_HOUR | TWELVE_HOUR | DAYyes
as_ofstring (date-time)yes
filters_appliedfrom | to | outcome | outcome_not[]yes
filters_ignoredq | trans_ref | sender_bank | api_key | after | charged | free_reason[]yes
seriesobject[]yes
series[].startstring (date-time)yes
series[].countsobjectyes

Possible errors

400401403429

An error as Problem Details. All codes are listed at Error codes