Get Usage | Sayari

The usage endpoint provides a simple interface to retrieve information on usage made by your API account. This includes both views per API path and credits consumed. The time period for the usage query is also specified in the response and whether or not this includes total usage.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

fromdateOptional

An ISO 8601 encoded date string indicating the starting time period to obtain usage stats. In the format YYYY-MM-DD

todateOptional

An ISO 8601 encoded date string indicating the ending time period to obtain usage stats. In the format YYYY-MM-DD

Response

usageobject

Usage information for each endpoint

fromstring

The start date of the returned usage information.

tostring

The end date of the returned usage information.

Errors

400

Bad Request

401

Unauthorized

404

Not Found

429

Rate Limit Exceeded

500

Internal Server Error

OAuth authentication of the form <token>.

An ISO 8601 encoded date string indicating the starting time period to obtain usage stats. In the format YYYY-MM-DD

An ISO 8601 encoded date string indicating the ending time period to obtain usage stats. In the format YYYY-MM-DD

Usage information for each endpoint

The start date of the returned usage information.

The end date of the returned usage information.

1	{
2	"usage": {
3	"entity": 1,
4	"record": 1,
5	"resolve": 1,
6	"search": 1,
7	"trade_traversal": 1,
8	"traversal": 1
9	},
10	"from": "from",
11	"to": "to"
12	}

1	{
2	"usage": {
3	"entity": 1,
4	"record": 1,
5	"resolve": 1,
6	"search": 1,
7	"trade_traversal": 1,
8	"traversal": 1
9	},
10	"from": "from",
11	"to": "to"
12	}

$	curl https://api.sayari.com/v1/usage \
>	-H "Authorization: Bearer <token>"