get
https://production-api.shoutaboutus.com/api/v1/solicitation/email-overage-summary
Get a paginated per store plan summary of email solicitation volume (count of solicitation emails sent per store_plan_id), used for the account-side email overage display.
Auth: Both — authentication bearer token. Target must sit inside your own account tree, keyed on the optional company_id/store_id; when you omit company_id it defaults to the auth user's own. A Partner login can pass any descendant account/store id (reaching its whole tree). An Account login reaches only its own account and stores under it.
Rate limit: No rate limit.
Request
- Query:
company_id(integer, optional) — filter by account/company id; defaults to auth user'sperson.company_id. Must belong to auth company hierarchy. - Query:
store_id(integer, optional) — filter by a single store; also restricts the email-count subquery to that store. Must belong to auth company hierarchy. - Query:
sort_field(string, optional) — one ofaccount_name,store_name,store_plan_id,store_plan_status,store_plan_end,email_sent_count. Ignored if not in this list (falls back to store name ASC). - Query:
sort_by(string, optional) —asc|ASC|desc|DESC; defaultASC. - Query:
search_field(string, optional) — one ofstore_name,account_name,store_plan_status,store_plan_end,store_plan_id(no angle brackets allowed). - Query:
search_value(string, optional) — value matched againstsearch_field(LIKE for name fields, exact/date otherwise; no angle brackets). - Query:
limit(integer, optional) — items per page, 10–100 (values below 10 are raised to 10); default 20.
Response — { data: [.] } envelope (paginator: data, links, meta).
id(integer) — store_plan id (also surfaced asstore_plan_id).account_name(string) — account company name, falling back to the store's location-company name.store_name(string) — the location's name, suffixed with the client location id when one is set (else the storeid).store_plan_id(integer) — store_plan id.store_plan_status(string) — the store plan'sstatus.store_plan_end(string|null) — the store plan'splan_enddate.email_sent_count(integer) — count of solicitation emails sent for that store plan (0 when none).
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
