Get review-request chart

Review-requests line chart for the account dashboard: a cumulative (running) count of sent review requests (email + SMS campaign requests combined) per time bucket across the window, bucketed by the request's sent_at. Bucket granularity is auto-selected from the range span (daily ≤30d / weekly ≤180d / monthly ≤730d / else yearly) with the timeline gap-filled.

Auth: Account — authentication, under the account/dashboard group (role-agnostic). Scope is the caller's company tree: store_id (if given) validated by an ownership check; otherwise all of the caller's stores.

Rate limit: No rate limit.

Request

  • Query: store_id (integer, optional) — must belong to the caller's company; omit it to cover all of your locations.
  • Query: range_start (string Y-m-d, optional) — defaults to start of 13 months ago.
  • Query: range_end (string Y-m-d, optional) — must be ≥ range_start; defaults to end of current month.
  • NOTE: The shared form request accepts review_site_id and may be sent in the URL, but this endpoint does NOT use it (review requests are not platform-specific).

Response{ data: [.] } envelope; an array of buckets in chronological order.

  • period (string) — bucket key.
  • count (integer) — cumulative count of email + SMS review requests up to and including this bucket.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string
string
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json