Get usage | ParsChat API

Reports message and conversation activity per robot over a window.

Returns every robot on your account by default. Pass robot_id to narrow it to one. Page with limit and offset: pagination.total_count tells you how many robots match, so you know how many calls to make before you start.

messages.total and messages.units are not the same number. A robot on the enhanced-accuracy model consumes two units per message, so reconcile billing against units and show total to your customer as a message count.

The window defaults to the last 30 days and may not span more than a year.

Pre-release: breakdown=source splits Instagram traffic by entry point. It adds fields rather than replacing them, so one parser handles both shapes. It is not callable yet; passing it today returns the standard payload.

This reports activity, not the account’s remaining balance.

Figures are cached rather than recomputed per request, so a very recent conversation may not be counted yet. metadata.processed_at is the moment the figures are accurate as of.

Reports message and conversation activity per robot over a window. Returns every robot on your account by default. Pass `robot_id` to narrow it to one. Page with `limit` and `offset`: `pagination.total_count` tells you how many robots match, so you know how many calls to make before you start. `messages.total` and `messages.units` are not the same number. A robot on the enhanced-accuracy model consumes two units per message, so reconcile billing against `units` and show `total` to your customer as a message count. The window defaults to the last 30 days and may not span more than a year. **Pre-release:** `breakdown=source` splits Instagram traffic by entry point. It adds fields rather than replacing them, so one parser handles both shapes. It is not callable yet; passing it today returns the standard payload. This reports activity, not the account's remaining balance. Figures are cached rather than recomputed per request, so a very recent conversation may not be counted yet. `metadata.processed_at` is the moment the figures are accurate as of.

Authentication

AuthorizationBearer

Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as Authorization: Bearer pk_live_….

Query parameters

fromdatetimeRequired

Start of the reporting window, inclusive. RFC 3339.

todatetimeRequired

End of the reporting window, inclusive. RFC 3339.

robot_idstringOptional

Report on one robot instead of all of them.

breakdownenumOptional

Pass source to split the totals by entry point: direct, comment, story_reply, story_mention, reel.

Allowed values:

limitintegerOptional1-100Defaults to 50

How many items to return per page.

offsetintegerOptional>=0Defaults to 0

How many records to skip. Use offset = page * limit, and total_count from the response to know when to stop.

Response

A page of per-robot usage.

windowobjectOptional

The period reported, echoing your query. Defaults to the last 30 days; may not span more than a year.

datalist of objectsOptional

One entry per robot in the window.

paginationobjectOptional

Offset pagination. total_count tells you how many records match, so you know how many pages to fetch before you start.

metadataobjectOptional

How fresh these figures are.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

Reports message and conversation activity per robot over a window.

The window defaults to the last 30 days and may not span more than a year.

This reports activity, not the account’s remaining balance.

Figures are cached rather than recomputed per request, so a very recent conversation may not be counted yet. metadata.processed_at is the moment the figures are accurate as of.