Customers

Every customer with spend in a window

Each (attribution.source, customerId) pair the tenant's charges were attributed to in the window, counted exactly as analytics counts customer spend, named from the customer directory, filterable by product, searchable, and paged past the analytics row cap. sources totals every product with customer spend in the window and ignores source and q. Enterprise workspaces only.

get/credits/analytics/customers

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/analytics/customers
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

days7 | 30 | 90

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

fromstring date-time

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

tostring date-time

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

sourcestring

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.

qstring

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

offsetinteger
limitinteger

Response

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

successtrue required
periodStartstring date-time required
periodEndExclusivestring date-time required
totalinteger required

Customers matching source and q, across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.