Get Usage Report

Inspect the detailed email and SMS review request usage funnel.

get_usage_report

Description

Returns the complete request-to-review funnel, including per-source click data. Use it when the user needs SMS opens, source-level click details, or a per-location tabular view. For a simpler account summary, use get_review_conversion_report.

Parameters

Parameter	Type	Required	Default	Description
startDate	string	No	—	Start date in MM/DD/YYYY format
endDate	string	No	—	End date in MM/DD/YYYY format
days	integer	No	30 when no period is requested	Relative window in days
months	integer	No	—	Relative window in months
reviewSites	list[integer]	No	All sources	Review source IDs to include
ratings	list[integer]	No	All ratings	Star ratings from 0 to 5
businessNumbers	list[integer]	No	All locations	Location IDs to include
reportType	string	No	Summary view	Pass "Tabular" for a per-location breakdown
sindex	integer	No	0	Pagination start index
count	integer	No	25	Records to return

Example Usage

Show review request performance location by location for the last 30 days.

Response Fields

Each row includes email and SMS sent, open, and click information; recommended and non-recommended source click counts; reviews generated by source; and totalReviewsCount. Summary mode returns a Total row, while tabular mode returns location rows.

Notes

All click percentages are based on the sent total for that channel, not the open total.