Docs menu

Postman & OpenAPI

All 11 public endpoints, ready to run in Postman, with auth, example bodies and saved IDs already set up.

Postman collection link

https://api.summarix.co.za/postman.json Download

Import in 30 seconds #

In Postman, click Import (top left) and choose Link.
Paste the collection link above and click Continue → Import. You get a Summarix API collection with folders for Account, Datasets, Reports, Calls and Ingestion.
Open the collection, go to the Variables tab, and set secretKey to your smx_sk_live_… key (from Dashboard → API keys). Set publicKey too if you'll try /v1/ingest. Click Save.
Run Account → Verify your key. A 200 means you're connected.

Requests chain on their own. Create a dataset saves datasetId, Generate a report uses it and saves reportId, and Get a report fetches it. Every request also has a status test, so you can run the whole collection in the Collection Runner or with newman in CI.

Collection variables #

Variable	What to put in it
`baseUrl`	Pre-set to `https://api.summarix.co.za`
`secretKey`	Your secret key. Used as the Bearer token for every request by default
`publicKey`	Your public key, for the ingest request
`pushToken`	The `ipt_…` part of a push integration URL
`datasetId · reportId · callId`	Filled in automatically by the create requests

Don't share or publish a collection with secretKey filled in. Postman syncs variable values to your workspace. Keep the secret in the Current value field, which stays local, or in a private Postman environment.

Automated testing with newman #

npx newman run "https://api.summarix.co.za/postman.json" \
  --env-var "secretKey=$SUMMARIX_SECRET_KEY" \
  --folder Account --folder Datasets

OpenAPI 3.1 #

Prefer Insomnia, Bruno, Swagger UI, or generating a typed client? Use the OpenAPI spec. Postman can import it too, through Import → Link with this URL.

https://api.summarix.co.za/openapi.json

# e.g. generate a TypeScript client
npx openapi-typescript "https://api.summarix.co.za/openapi.json" -o summarix.d.ts

The collection and the spec are generated from the same definitions as this documentation, so they always match the live API.