List website visits
Retrieve a paginated list of website visits.
Request
- Base URLhttps://api.commonroom.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The maximum number of visits to return per page
Pagination cursor from a previous response
Comma-separated list of additional columns to include in the response. Valid column values: url (included by default), contactId, organizationId. The meta column recordCount can be requested to return the total number of matching visits in meta.recordCount.
Filter visits by prefixed contact ID (format c_<number>)
Filter visits by prefixed organization ID (format o_<number>)
Structured filter as URL-encoded JSON — see the LightFilterExpression schema for the grammar. Conditions are combined (AND) with the other query parameters. To filter by contact or organization, use the dedicated contactId / organizationId query parameters above.
Filterable fields:
| Field | Filter type | Operators | Description |
|---|---|---|---|
| visitTime | dateRangeFilter | in, between, after, before | Filter website visits by time range. |
| url | stringFilter | eq, like | Filter website visits by URL. Use like for partial match (contains). |
Filtering by a related entity: a group whose target names another entity applies its clauses to that entity, using the fields of that entity's list endpoint. Every group must send target, objectConfigId and targetAssocPaths, using null for any it doesn't use. Targets this endpoint accepts:
| Target | Matches website visits | Clauses use |
|---|---|---|
| Contact (alias Member) | whose visitor matches | GET /contacts fields |
| Organization (alias Company) | whose organization matches | GET /organizations fields |
| Object | whose organization's website equals the domain of a matching custom object; set objectConfigId to its type (cot_<id>). Objects without a domain never match | GET /objects fields |
Any other target returns a 400.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.