get_account_overview
Returns the account with parts chosen by include: setup, credits, optin and stats. Without include you get setup and credits. optin needs contacts:read and stats needs stats:read; plan and invoices are not included.
| Tool name | get_account_overview |
| Permission | account:read |
readOnlyHint | true |
destructiveHint | false |
idempotentHint | true |
openWorldHint | false |
| REST call | GET /v1/account/overview |
#What it does
- Only reads data. It changes nothing and sends nothing.
#Input
The tool takes one flat object. Path, query and body fields of the REST call are merged into it.
| Name | Type | Required | Description |
|---|---|---|---|
include | string | no | Comma-separated parts: setup, credits, optin, stats. Default: setup,credits. up to 60 characters |
range | string | no | Range for the stats part: 7d, 30d (default) or 90d. one of: 7d, 30d, 90d; default "30d" |
#Result
The result has the same content as the REST answer. Lists have at most 50 items per page (default 20); use cursor for the next page.
Errors come back as a tool result with isError: true. The error codes are the ones in Errors.