Browse developer documentation
Read-only tool
get_recent_sales
Read recorded payments and refunds, newest first, with observed attribution details.
Access: OAuth analytics:read or a privately configured workspace key.
Arguments
| Field | Type | Description |
|---|---|---|
compare | string | Comparison range. Values: previous_period, mom, qoq, yoy, none. Default: |
cursor | string | Opaque next_cursor from the previous result. Keep the same website, dates, report, model, visitor filters and funnel selector. |
filters | array | JSON array of up to twenty visitor filters, for example [{"dim":"country","op":"is","value":"US"}]. Dimensions: source, channel, campaign, entry_page, page, hostname, country, device, browser, os, goal. Operators: is, is_not. Values are exact strings up to 500 characters. All filters must match the visitor across available history; report dates then select activity for that cohort. Unmatched payments are excluded. Crawler counts remain website-wide; spend requires every filter to be source/channel/campaign. Preserve filters when paging. |
from | string | Inclusive start date. Supply to as well. |
limit | integer | Maximum rows on this page. Default: |
model | string | How recorded sources share revenue credit. Values: first_touch, last_touch, linear, time_decay. Default: |
period | string | UTC date selection. from and to override period. Values: realtime, today, yesterday, 7d, 30d, 90d, 12m, wtd, mtd, qtd, ytd, all. Default: |
site | string | Website ID or domain. Required when the workspace has more than one website. |
to | string | Inclusive end date. Supply from as well. |
filters[] fields
| Field | Type | Description |
|---|---|---|
dim | string | Values: source, channel, campaign, entry_page, page, hostname, country, device, browser, os, goal. |
op | string | Values: is, is_not. |
value | string |
Read sales
Use this JSON-RPC call through an initialized MCP client. Replace example values with your actual website, dates or confirmed setup details.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_recent_sales",
"arguments": {
"site": "site_example",
"from": "2026-10-01",
"to": "2026-10-07",
"compare": "none"
}
}
}Decoded result
Illustrative JSON parsed from the result’s text block.
{
"site": {
"id": "site_example",
"domain": "shop.example.com",
"currency": "USD"
},
"period": {
"from": "2026-10-01T00:00:00.000Z",
"to": "2026-10-08T00:00:00.000Z",
"label": "Custom",
"compare": "none",
"attribution_model": "first_touch"
},
"sales": [
{
"id": "tx_example",
"provider": "stripe",
"external_id": "order_123",
"type": "one_time",
"amount": 5000,
"currency": "USD",
"customer_email": null,
"transacted_at": "2026-10-01T12:00:00Z",
"attributed": true,
"first_touch": "Google Organic",
"last_touch": "Direct",
"touches": 2,
"self_reported_source": null
}
]
}Result fields
| Field | Type | Description |
|---|---|---|
site | object | Website ID, domain and currency. |
period | object | Resolved UTC boundaries; to is the exclusive timestamp after the selected end date. |
sales | array | Report records. See the fields below. |
next_cursor | string | null | When provided, pass this value to continue; null means the last page. Some small-site reports omit this field. |
coverage | object | When provided, describes completeness, snapshot time and row coverage. Row limits apply to this page, not to headline totals. |
site fields
| Field | Type | Description |
|---|---|---|
id | string | Website ID. |
domain | string | Website domain. |
currency | string | Three-letter currency. |
period fields
| Field | Type | Description |
|---|---|---|
from | string | Inclusive UTC start. |
to | string | Exclusive UTC end. |
label | string | Human-readable date selection. |
compare | string | Comparison selection. |
attribution_model | string | Revenue-credit model. |
sales[] fields
| Field | Type | Description |
|---|---|---|
id | string | Stored transaction ID. |
provider | string | Payment provider. |
external_id | string | Provider transaction ID. |
type | string | one_time, subscription_new, subscription_renewal or refund. |
amount | integer | Signed integer cents; refunds are negative. |
currency | string | Transaction currency. |
customer_email | string | null | Customer email or null. Treat as private data. |
transacted_at | string | UTC transaction time. |
attributed | boolean | Whether a preceding observed source was linked. |
first_touch | string | null | First source or null. |
last_touch | string | null | Last source or null. |
touches | integer | Preceding observed touches. |
self_reported_source | string | null | Survey answer or null. |
The decoded data follows the sales response contract, without the REST envelope.
Full MCP result wrapper
{
"content": [
{
"type": "text",
"text": "{\n \"site\": {\n \"id\": \"site_example\",\n \"domain\": \"shop.example.com\",\n \"currency\": \"USD\"\n },\n \"period\": {\n \"from\": \"2026-10-01T00:00:00.000Z\",\n \"to\": \"2026-10-08T00:00:00.000Z\",\n \"label\": \"Custom\",\n \"compare\": \"none\",\n \"attribution_model\": \"first_touch\"\n },\n \"sales\": [\n {\n \"id\": \"tx_example\",\n \"provider\": \"stripe\",\n \"external_id\": \"order_123\",\n \"type\": \"one_time\",\n \"amount\": 5000,\n \"currency\": \"USD\",\n \"customer_email\": null,\n \"transacted_at\": \"2026-10-01T12:00:00Z\",\n \"attributed\": true,\n \"first_touch\": \"Google Organic\",\n \"last_touch\": \"Direct\",\n \"touches\": 2,\n \"self_reported_source\": null\n }\n ]\n}"
}
]
}Behavior and limits
Money is integer cents in site.currency. Percentages use a 0–100 scale.
An unattributed payment is still a payment. Importing history does not recreate unobserved visits.
Keep customer_email and visitor identifiers in authorized private systems.
Report tools return the report data directly inside MCP text content. They do not add the REST status/data envelope.
With multiple websites and no site argument, this report tool returns needs_site: true and the available websites. Choose a real website and call it again.