The shop usage API returns the usage data for your shop.
Request Parameters #
You may perform requests to the API using the following curl equivalent:
curl -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' -XPOST https://releva.ai/api/v0/usage -d'{
"fromDate": "2021-03-01T00:00:00.000Z",
"toDate": "2021-04-01T00:00:00.000Z"
}'Request Body #
| Field | Type | Description |
|---|---|---|
| fromDate | ISO-8601 String (Optional) | The start date of the usage data (inclusive) |
| toDate | ISO-8601 String (Optional) | The end date of the usage data (exclusive) |
A successful response will return HTTP Status 200 and a JSON body with the following structure:
{"usage":{"textMessageSends":0,"pushNotificationSends":0,"pageViews":0,"emailSends":0}}Response Format #
An error response will return a HTTP 4xx or 5xx status code and have the following structure:
{
"message": "A description of the error and how to fix it, if it's a client error."
}