Show Developer Menu

GET /reports/volume

Returns a daily volume count. By default, returns data for all brands in your account. Use the brand parameter to filter to a specific brand.

Example Request
curl 'https://{brand}.reamaze.io/api/v1/reports/volume' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
{
  "conversation_counts":
    {
      ...
      "2017-07-19": 100,
      "2017-07-20": 200,
      ...
    },
  "start_date": "2017-07-01",
  "end_date": "2017-07-30"
}
Optional Params
  • brand - Filter by brand URL (e.g., mybrand). Without this parameter, returns data for all brands in your account
  • start_date - Choose the start of the report (defaults to 30 days ago)
  • end_date - Choose the end of the report (defaults to today)

The start and end dates of the report will default to the last 30 days. Time frames can be no smaller than 1 day and no larger than 1 year.

Example with Brand Filter
curl 'https://{brand}.reamaze.io/api/v1/reports/volume?brand=mybrand&start_date=2024-01-01&end_date=2024-01-31' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'