Skip to main content
GET
Every customer with spend in a window

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito). High-risk workspace administration requires an owner or admin role and fresh MFA/passkey step-up.

Query Parameters

days
enum<integer>
default:30

Legacy form, as analytics. Cannot be combined with from/to.

Available options:
7,
30,
90
from
string<date-time>

Window start, inclusive. Strict ISO-8601. Requires to.

to
string<date-time>

Window end, EXCLUSIVE. Strict ISO-8601. Requires from.

source
string

Only this product's customers (attribution.source), exactly as tagged. Send it empty (source=) for customers with no product tag; omit it for every product.

Maximum string length: 128
q
string

Case-insensitive literal substring of the directory name, the link, or the customer id.

Maximum string length: 120
offset
integer
default:0
Required range: 0 <= x <= 2147483647
limit
integer
default:50
Required range: 1 <= x <= 100

Response

One page of customers, the matching total, and per-product totals

success
boolean
required
periodStart
string<date-time>
required
periodEndExclusive
string<date-time>
required
total
integer
required

Customers matching source and q, across all pages.

customers
object[]
required
sources
object[]
required