Core-12
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
GET | |
GET | |
PATCH | |
DELETE | |
GET | |
GET | |
POST | |
DELETE | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
GET |
Retrieve integrations domain connect check
Path parameters
- project_idstring
Example request
GET /api /projects /:project_id /integrations /domain-connect /checkExample response
Status 200 No response body
List all property definitions
Required API key scopes
property_definition:readPath parameters
- project_idstring
Query parameters
- event_namesstring
- exclude_core_propertiesbooleanDefault:
false - exclude_hiddenbooleanDefault:
false - excluded_propertiesstring
- filter_by_event_namesboolean
- group_type_indexinteger
- is_feature_flagboolean
- is_numericalboolean
- limitinteger
- offsetinteger
- propertiesstring
- searchstring
- typestringDefault:
eventOne of:"event""person""group""session"
Response
Example request
GET /api /projects /:project_id /property_definitionsExample response
Status 200
RESPONSE
Retrieve property definitions
Required API key scopes
property_definition:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /projects /:project_id /property_definitions /:idExample response
Status 200
RESPONSE
Update property definitions
Required API key scopes
property_definition:writePath parameters
- idstring
- project_idstring
Request parameters
- descriptionstring
- tagsarray
- property_type
- verifiedboolean
- hiddenboolean
Response
Example request
PATCH /api /projects /:project_id /property_definitions /:idExample response
Status 200
RESPONSE
Delete property definitions
Required API key scopes
property_definition:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /projects /:project_id /property_definitions /:idExample response
Status 204 No response body
Retrieve property definitions seen together
Allows a caller to provide a list of event names and a single property name Returns a map of the event names to a boolean representing whether that property has ever been seen with that event_name
Required API key scopes
property_definition:readPath parameters
- project_idstring
Example request
GET /api /projects /:project_id /property_definitions /seen_togetherExample response
Status 200 No response body
List all session recordings sharing
Required API key scopes
sharing_configuration:readPath parameters
- project_idstring
- recording_idstring
Example request
GET /api /projects /:project_id /session_recordings /:recording_id /sharingExample response
Status 200
RESPONSE
Create session recordings sharing passwords
Create a new password for the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- project_idstring
- recording_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /projects /:project_id /session_recordings /:recording_id /sharing /passwordsExample response
Status 200
RESPONSE
Delete session recordings sharing passwords
Delete a password from the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- password_idstring
- project_idstring
- recording_idstring
Example request
DELETE /api /projects /:project_id /session_recordings /:recording_id /sharing /passwords /:password_idExample response
Status 204 No response body
Create session recordings sharing refresh
Required API key scopes
sharing_configuration:writePath parameters
- project_idstring
- recording_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /projects /:project_id /session_recordings /:recording_id /sharing /refreshExample response
Status 200
RESPONSE
List all subscriptions
Required API key scopes
subscription:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /subscriptionsExample response
Status 200
RESPONSE
Create subscriptions
Required API key scopes
subscription:writePath parameters
- project_idstring
Request parameters
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
Example request
POST /api /projects /:project_id /subscriptionsExample response
Status 201
RESPONSE
Retrieve subscriptions
Required API key scopes
subscription:readPath parameters
- idinteger
- project_idstring
Response
Example request
GET /api /projects /:project_id /subscriptions /:idExample response
Status 200
RESPONSE
Update subscriptions
Required API key scopes
subscription:writePath parameters
- idinteger
- project_idstring
Request parameters
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
Example request
PATCH /api /projects /:project_id /subscriptions /:idExample response
Status 200
RESPONSE
Delete subscriptions
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
subscription:writePath parameters
- idinteger
- project_idstring
Example request
DELETE /api /projects /:project_id /subscriptions /:idExample response
Status 405 No response body
List all users
Required API key scopes
user:readQuery parameters
- emailstring
- is_staffboolean
- limitinteger
- offsetinteger
Response
Example request
GET /api /usersExample response
Status 200
RESPONSE
Retrieve users
Required API key scopes
user:readPath parameters
- uuidstring
Response
Example request
GET /api /users /:uuidExample response
Status 200
RESPONSE