Get Usage

GET

/v1/usage

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.

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.

Built with

1	curl -G https://api.sayari.com/v1/usage \
2	-H "Authorization: Bearer <token>" \
3	-d from=2023-01-01 \
4	-d to=2023-01-01

1	{
2	"usage": {
3	"entity": 0,
4	"record": 0,
5	"resolve": 0,
6	"search": 0,
7	"search_entities": 0,
8	"search_records": 0,
9	"search_trade": 0,
10	"trade_traversal": 0,
11	"traversal": 0
12	},
13	"from": "string",
14	"to": "string"
15	}