Analytics

Retrieve transaction summaries grouped by contact

post/v1/analytics/transaction-summaries

Request

Base URL
https://api.squarespace.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/squarespace/apis/commerce-api/docs/v1/analytics/transaction-summaries/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Request body

contactIdsstring[] required

groupBy'contactId' required

Field to group results by, should be a contactId

Example request

{
  "groupBy": "contactId"
}

Response

Transaction summaries retrieved

Example response

{
  "transactionsSummaryWrappers": [
    {
      "contactId": "a6e74e0c-2b4a-4b63-b4a3-9c5d1f3e8a7b",
      "transactionsSummary": {
        "totalDonationAmount": {
          "value": 49.99
        },
        "totalOrderAmount": {
          "value": 49.99
        },
        "totalRefundAmount": {
          "value": 49.99
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.