Skip to navigation
API ReferenceVisits

SearchVisits

SearchVisits pages through one of the team’s sites’ visits, newest first unless order_by says otherwise, 25 a page by default. conditions must name exactly one site with a siteId condition.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Headers

Edulead-TeamstringRequired

Query parameters

conditionsstringOptional<=4096 characters

A JSON array of up to 30 conditions, all of which must hold: [{“field”: “siteId”, “operator”: “equals”, “value”: “<site id>”}, …]. Fields: siteId (equals; required, one site), ingestedAt (equals, gt, gte, lt, lte, between, between_string; an ISO 8601 date or date-time, or epoch milliseconds), and geo.subdivisions.isoCode (equals; “TX,CA” matches either).

order_byenumOptional

Sort order: a sortable field name, optionally followed by ” desc”. The allowed values are listed.

Allowed values:
page_sizeintegerOptional0-100
Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
page_tokenstringOptional<=1024 characters

Opaque token from a previous response; empty for the first page.

Response

Success
itemslist of objectsOptional
The page of results, in the requested order.
next_page_tokenstringOptional

Token for the next page; empty when this is the last page.

total_sizestringOptionalformat: "int64"
How many visits match the conditions, over every page.