state-reader/COUNT

Used to return the total number of offers a Collector has opted-into/saved.
GET /offers/state-reader/v1/count

Take a look at our OpenAPI (Swagger-Spec) schema to learn more about the API calls.

Used to return the total number of offers a Collector has opted-into/saved. This is used for displaying a small numerical icon on a label or button within your website or mobile app.

Sample request

curl -X GET 
  https://cert.airmilesapis.ca/offers/state-reader/v1/count \
  --header 'Content-Type: application/json' \
  --header 'x-correlation-id: acd31d3c-f486-4092-9c07-1b82632829ed' \
  --header 'x-origin-client: external:partner:web' \
  --header 'x-local-time: 2021-07-07T23:59:59' \
  --header 'Authorization: Bearer LQoD0gWJK7l9znrmsGksWxbvIEx9a8zXkw...' \
  --data-raw ''

Query parameters

Parameter Description
state The state types you want to retrieve.
partnerId The unique ID of the partner.
region The Collector region.

Sample response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 29 Oct 2018 15:27:34 GMT
{
    "count": 3
}

Response properties

Property Description
count The total number of offers a Collector has opted-into/saved.

Response codes

Code Description
200 Request Successful
400 Bad Request
401 Unauthorized
404 Record Not Found
500 Internal Server Error