Analytics

Download schema

Query analytics for a website

Retrieve transaction summaries grouped by contact

POST

https://api.squarespace.com

/v1/analytics/transaction-summaries

Retrieve transaction summaries grouped by contact › Headers

Authorization

string · required

API key or OAuth access token

Default: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN

User-Agent

string · required

User Agent

Default: YOUR_CUSTOM_APP_DESCRIPTION

Retrieve transaction summaries grouped by contact › Request Body

RetrieveTransactionsSummariesRequest

contactIds

string[] · minItems: 1 · maxItems: 1000 · required

groupBy

string · enum · minLength: 1 · required

Field to group results by, should be a contactId

Enum values:

contactId

Example: contactId

Retrieve transaction summaries grouped by contact › Responses

Transaction summaries retrieved

RetrieveTransactionsSummariesResponse

TransactionsSummaryWrapper[]

List of transaction summary wrappers

POST/v1/analytics/transaction-summaries

curl https://api.squarespace.com/v1/analytics/transaction-summaries \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: YOUR_CUSTOM_APP_DESCRIPTION' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "contactIds": [
    "string"
  ],
  "groupBy": "contactId"
}'

Example Request Body

{
  "contactIds": [
    "string"
  ],
  "groupBy": "contactId"
}

json

Example Responses

{
  "transactionsSummaryWrappers": [
    {
      "contactId": "a6e74e0c-2b4a-4b63-b4a3-9c5d1f3e8a7b",
      "transactionsSummary": {
        "donationCount": 0,
        "firstDonationSubmittedOn": "2024-08-25T15:00:00Z",
        "firstOrderSubmittedOn": "2024-08-25T15:00:00Z",
        "lastDonationSubmittedOn": "2024-08-25T15:00:00Z",
        "lastOrderSubmittedOn": "2024-08-25T15:00:00Z",
        "orderCount": 0,
        "totalDonationAmount": {
          "currency": "USD",
          "value": 49.99
        },
        "totalOrderAmount": {
          "currency": "USD",
          "value": 49.99
        },
        "totalRefundAmount": {
          "currency": "USD",
          "value": 49.99
        }
      }
    }
  ]
}

json

application/json

Contacts Discounts