Squarespace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Commerce Analytics API

2 actions 2 updates phrasing extends openapi/squarespace-analytics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Squarespace's API. It is a proposal applied on top of the contract, not a document Squarespace publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/analytics/transaction-summaries'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Commerce Analytics API
  version: 1.0.0
extends: openapi/squarespace-analytics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1/analytics/transaction-summaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize transactions for a set of contacts
      effect: read
      questions:
      - How much has each of my Squarespace contacts spent in total?
      - Can I get transaction totals grouped per contact for a list of contact IDs?
      - What does a per-contact transaction summary include for my store customers?
      instructions:
      - text: Get transaction summaries for contacts {contactIds}, grouped by {groupBy}.
        slots:
          contactIds: requestBody.contactIds
          groupBy: requestBody.groupBy
      - text: Total up the purchases of contacts {contactIds} per contact using group field {groupBy}.
        slots:
          contactIds: requestBody.contactIds
          groupBy: requestBody.groupBy
      method: generated
      generated: '2026-10-01'