Docs

Your Check API usage

Preview· P9
GET
/checks/usage

Your own calls by day, live and test, how many were billed, and by outcome. The counts lag the calls by up to a minute, and your daily and monthly caps are read from them.

Key: a Check API key, agoo_ck_live_ or agoo_ck_test_, with checks:read.

Authorization

bearerAuth checks:read
headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it
agoo_ck_live_Check API key, live mode, for a Check API partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs above, answering only the published test values, never billed

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: checks:read

Query Parameters

month?string

The month, as YYYY-MM; this month when left out.

Match^[0-9]{4}-[0-9]{2}$

Header Parameters

Origin?string

Sent by browsers. A Check API key can't be used from a browser: a request with it is refused (403).

Response Body

The month's usage.

application/json
  1. response
object*"check_usage"
Value in"check_usage"
month*string
lag_seconds*integer

Counts lag the calls by up to a minute.

days*array<>
curl -X GET 'https://api.agoohq.com/v1/checks/usage'
{  "object": "check_usage",  "month": "string",  "lag_seconds": 0,  "days": [    {      "day": "2019-08-24",      "livemode": true,      "calls": 0,      "billed": 0,      "outcomes": {        "property1": 0,        "property2": 0      }    }  ]}