Product
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
GET | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
GET | |
GET | |
POST | |
GET | |
POST |
List all environments elements
Required API key scopes
element:readPath parameters
- environment_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /elementsExample response
Status 200
Create environments elements
Required API key scopes
element:writePath parameters
- environment_idstring
Request parameters
- textstring
- tag_namestring
- attr_classarray
- hrefstring
- attr_idstring
- nth_childinteger
- nth_of_typeinteger
- attributes
- orderinteger
Response
Example request
POST /api /environments /:environment_id /elementsExample response
Status 201
Retrieve environments elements
Required API key scopes
element:readPath parameters
- environment_idstring
- idinteger
Response
Example request
GET /api /environments /:environment_id /elements /:idExample response
Status 200
Update environments elements
Required API key scopes
element:writePath parameters
- environment_idstring
- idinteger
Request parameters
- textstring
- tag_namestring
- attr_classarray
- hrefstring
- attr_idstring
- nth_childinteger
- nth_of_typeinteger
- attributes
- orderinteger
Response
Example request
PATCH /api /environments /:environment_id /elements /:idExample response
Status 200
Delete environments elements
Required API key scopes
element:writePath parameters
- environment_idstring
- idinteger
Example request
DELETE /api /environments /:environment_id /elements /:idExample response
Status 204 No response body
Retrieve environments elements stats
The original version of this API always and only returned $autocapture elements If no include query parameter is sent this remains true. Now, you can pass a combination of include query parameters to get different types of elements Currently only $autocapture and $rageclick and $dead_click are supported
Required API key scopes
element:readPath parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /elements /statsExample response
Status 200 No response body
Retrieve environments elements values
Required API key scopes
element:readPath parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /elements /valuesExample response
Status 200 No response body
List all environments insights
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Required API key scopes
insight:readPath parameters
- environment_idstring
Query parameters
- basicboolean
- formatstringOne of:
"csv""json" - limitinteger
- offsetinteger
- refreshstringDefault:
force_cacheOne of:"async""async_except_on_cache_miss""blocking""force_async""force_blocking""force_cache""lazy_async" - short_idstring
Response
Example request
GET /api /environments /:environment_id /insightsExample response
Status 200
Create environments insights
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Required API key scopes
insight:writePath parameters
- environment_idstring
Query parameters
- formatstringOne of:
"csv""json"
Request parameters
- namestring
- derived_namestring
- query
- orderinteger
- deletedboolean
- dashboardsarray
- descriptionstring
- tagsarray
- favoritedboolean
- _create_in_folderstring
Response
Example request
POST /api /environments /:environment_id /insightsExample response
Status 201
Retrieve environments insights
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Required API key scopes
insight:readPath parameters
- environment_idstring
- id
Query parameters
- formatstringOne of:
"csv""json" - from_dashboardinteger
- refreshstringDefault:
force_cacheOne of:"async""async_except_on_cache_miss""blocking""force_async""force_blocking""force_cache""lazy_async"
Response
Example request
GET /api /environments /:environment_id /insights /:idExample response
Status 200
Update environments insights
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Required API key scopes
insight:writePath parameters
- environment_idstring
- id
Query parameters
- formatstringOne of:
"csv""json"
Request parameters
- namestring
- derived_namestring
- query
- orderinteger
- deletedboolean
- dashboardsarray
- descriptionstring
- tagsarray
- favoritedboolean
- _create_in_folderstring
Response
Example request
PATCH /api /environments /:environment_id /insights /:idExample response
Status 200
Delete environments insights
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
insight:writePath parameters
- environment_idstring
- id
Query parameters
- formatstringOne of:
"csv""json"
Example request
DELETE /api /environments /:environment_id /insights /:idExample response
Status 405 No response body
Retrieve environments insights activity retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Required API key scopes
activity_log:readPath parameters
- environment_idstring
- idinteger
Query parameters
- formatstringOne of:
"csv""json"
Example request
GET /api /environments /:environment_id /insights /:id /activityExample response
Status 200 No response body
Retrieve environments insights analyze
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Path parameters
- environment_idstring
- idinteger
Query parameters
- formatstringOne of:
"csv""json"
Example request
GET /api /environments /:environment_id /insights /:id /analyzeExample response
Status 200 No response body
Retrieve environments insights suggestions
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Path parameters
- environment_idstring
- idinteger
Query parameters
- formatstringOne of:
"csv""json"
Example request
GET /api /environments /:environment_id /insights /:id /suggestionsExample response
Status 200 No response body
Create environments insights suggestions
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Path parameters
- environment_idstring
- idinteger
Query parameters
- formatstringOne of:
"csv""json"
Request parameters
- namestring
- derived_namestring
- query
- orderinteger
- deletedboolean
- dashboardsarray
- descriptionstring
- tagsarray
- favoritedboolean
- _create_in_folderstring
Example request
POST /api /environments /:environment_id /insights /:id /suggestionsExample response
Status 200 No response body
Retrieve environments insights activity
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Required API key scopes
activity_log:readPath parameters
- environment_idstring
Query parameters
- formatstringOne of:
"csv""json"
Example request
GET /api /environments /:environment_id /insights /activityExample response
Status 200 No response body
Create environments insights cancel
DRF ViewSet mixin that gates coalesced responses behind permission checks.
The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
Path parameters
- environment_idstring
Query parameters
- formatstringOne of:
"csv""json"
Request parameters
- namestring
- derived_namestring
- query
- orderinteger
- deletedboolean
- dashboardsarray
- descriptionstring
- tagsarray
- favoritedboolean
- _create_in_folderstring
Example request
POST /api /environments /:environment_id /insights /cancel