Make your first API request

Use these read-only requests to check authentication and retrieve visitor data. You need an organization API key from Settings > API Keys and curl on your computer or server. Set LEADPIPE_API_KEY in your local environment or secret manager before running the examples.

Check account status

curl --fail-with-body --silent --show-error \
  "https://api.aws53.cloud/v1/data/account" \
  -H "X-API-Key: $LEADPIPE_API_KEY"

A successful response contains data.healthy, organization status, credits, pixels, and intent access. Check these values before diagnosing missing visitor data. See Account status for the response schema.

Retrieve visitors

curl --fail-with-body --silent --show-error --get \
  "https://api.aws53.cloud/v1/data" \
  -H "X-API-Key: $LEADPIPE_API_KEY" \
  --data-urlencode "timeframe=7d" \
  --data-urlencode "page=1"

A successful list request returns visitor records in data and pagination information in meta. An empty list can mean there is no identified activity in the selected scope. Check the pixel and date range before treating it as an authentication problem. For one site, pass pixelId or domain; do not combine them. Get pixel IDs from List pixels.

Continue your integration

Task	Guide
Retrieve one visitor’s journey	Visitor data
Read bounded session facts	Session summaries
Read a saved segment	Query qualified visitors
Exclude unwanted traffic	Visitor suppression
Resolve errors or rate limits	Authentication and errors

Keep the API key in your backend. The pixel snippet runs in the browser and does not contain an API key.

Start here

Visitors

Pixels

Visitor suppression

Account status

Make your first API request

Check account status

Retrieve visitors

Continue your integration

​Check account status

​Retrieve visitors

​Continue your integration

Check account status

Retrieve visitors

Continue your integration