Sessionrecordingplaylists 4 endpoints

PUT /api/projects/{project_id}/session_recording_playlists/{short_id}
operationId: Sessionrecordingplaylists_updateRecordingPlaylist

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
short_id path required string —

Request Body

application/json
schema SessionRecordingPlaylist
Property Type Required
id integer required
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string required
last_modified_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
multipart/form-data
schema SessionRecordingPlaylist
Property Type Required
id integer required
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string required
last_modified_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
application/x-www-form-urlencoded
schema SessionRecordingPlaylist
Property Type Required
id integer required
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string required
last_modified_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional

Responses

200 —
PUT /api/projects/{project_id}/session_recording_playlists/{short_id}
GET /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings
operationId: Sessionrecordingplaylists_getRecordings

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
short_id path required string —

Responses

200 —
GET /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings
DELETE /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}
operationId: Sessionrecordingplaylists_deleteRecording

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
session_recording_id path required string —
short_id path required string —

Responses

204

No response body
DELETE /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}
POST /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}
operationId: Sessionrecordingplaylists_createRecording

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
session_recording_id path required string —
short_id path required string —

Request Body

application/json
schema SessionRecordingPlaylist
Property Type Required
id integer required
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string required
last_modified_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
multipart/form-data
schema SessionRecordingPlaylist
Property Type Required
id integer required
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string required
last_modified_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
application/x-www-form-urlencoded
schema SessionRecordingPlaylist
Property Type Required
id integer required
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string required
last_modified_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional

Responses

200 —
POST /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}

Sessionrecordings 11 endpoints

GET /api/projects/{project_id}/session_recordings
operationId: Sessionrecordings_getMultiple

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/session_recordings
GET /api/projects/{project_id}/session_recordings/error_clusters
operationId: Sessionrecordings_getErrorClusters

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/session_recordings/error_clusters
GET /api/projects/{project_id}/session_recordings/matching_events 
    Gets a list of event ids that match the given session recording filter.
    The filter must include a single session ID.
    And must include at least one event or action filter.
    This API is intended for internal use and might have unannounced breaking changes.
operationId: Sessionrecordings_getSessionRecordingMatchingEvents

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/session_recordings/matching_events
GET /api/projects/{project_id}/session_recordings/properties
operationId: Sessionrecordings_getProperties

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/session_recordings/properties
DELETE /api/projects/{project_id}/session_recordings/{id}
operationId: Sessionrecordings_deleteById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this session recording.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

204

No response body
DELETE /api/projects/{project_id}/session_recordings/{id}
GET /api/projects/{project_id}/session_recordings/{id}
operationId: Sessionrecordings_getById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this session recording.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/session_recordings/{id}
POST /api/projects/{project_id}/session_recordings/{id}/persist
operationId: Sessionrecordings_persistSessionRecording

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this session recording.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

application/json
schema SessionRecording
Property Type Required
id string required
person object optional
└ id integer required
└ name string required
└ uuid string required
└ created_at string required
└ properties object optional
└ distinct_ids string required
viewed string required
storage string required
end_time string required
start_url string required
start_time string required
click_count integer required
distinct_id string required
active_seconds integer required
keypress_count integer required
inactive_seconds integer required
console_log_count integer required
console_warn_count integer required
recording_duration integer required
console_error_count integer required
mouse_activity_count integer required
multipart/form-data
schema SessionRecording
Property Type Required
id string required
person object optional
└ id integer required
└ name string required
└ uuid string required
└ created_at string required
└ properties object optional
└ distinct_ids string required
viewed string required
storage string required
end_time string required
start_url string required
start_time string required
click_count integer required
distinct_id string required
active_seconds integer required
keypress_count integer required
inactive_seconds integer required
console_log_count integer required
console_warn_count integer required
recording_duration integer required
console_error_count integer required
mouse_activity_count integer required
application/x-www-form-urlencoded
schema SessionRecording
Property Type Required
id string required
person object optional
└ id integer required
└ name string required
└ uuid string required
└ created_at string required
└ properties object optional
└ distinct_ids string required
viewed string required
storage string required
end_time string required
start_url string required
start_time string required
click_count integer required
distinct_id string required
active_seconds integer required
keypress_count integer required
inactive_seconds integer required
console_log_count integer required
console_warn_count integer required
recording_duration integer required
console_error_count integer required
mouse_activity_count integer required

Responses

200 —
POST /api/projects/{project_id}/session_recordings/{id}/persist
GET /api/projects/{project_id}/session_recordings/{id}/similar_sessions
operationId: Sessionrecordings_getSimilarSessions

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this session recording.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/session_recordings/{id}/similar_sessions
GET /api/projects/{project_id}/session_recordings/{id}/snapshots

Snapshots can be loaded from multiple places:

  1. From S3 if the session is older than our ingestion limit. This will be multiple files that can be streamed to the client
  2. or from Redis if the session is newer than our ingestion limit.

Clients need to call this API twice.
First without a source parameter to get a list of sources supported by the given session.
And then once for each source in the returned list to get the actual snapshots.

NB version 1 of this API has been deprecated and ClickHouse stored snapshots are no longer supported.

operationId: Sessionrecordings_snapshotsRetrieve

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this session recording.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/session_recordings/{id}/snapshots
POST /api/projects/{project_id}/session_recordings/{id}/summarize
operationId: Sessionrecordings_summarizeCreate

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this session recording.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

application/json
schema SessionRecording
Property Type Required
id string required
person object optional
└ id integer required
└ name string required
└ uuid string required
└ created_at string required
└ properties object optional
└ distinct_ids string required
viewed string required
storage string required
end_time string required
start_url string required
start_time string required
click_count integer required
distinct_id string required
active_seconds integer required
keypress_count integer required
inactive_seconds integer required
console_log_count integer required
console_warn_count integer required
recording_duration integer required
console_error_count integer required
mouse_activity_count integer required
multipart/form-data
schema SessionRecording
Property Type Required
id string required
person object optional
└ id integer required
└ name string required
└ uuid string required
└ created_at string required
└ properties object optional
└ distinct_ids string required
viewed string required
storage string required
end_time string required
start_url string required
start_time string required
click_count integer required
distinct_id string required
active_seconds integer required
keypress_count integer required
inactive_seconds integer required
console_log_count integer required
console_warn_count integer required
recording_duration integer required
console_error_count integer required
mouse_activity_count integer required
application/x-www-form-urlencoded
schema SessionRecording
Property Type Required
id string required
person object optional
└ id integer required
└ name string required
└ uuid string required
└ created_at string required
└ properties object optional
└ distinct_ids string required
viewed string required
storage string required
end_time string required
start_url string required
start_time string required
click_count integer required
distinct_id string required
active_seconds integer required
keypress_count integer required
inactive_seconds integer required
console_log_count integer required
console_warn_count integer required
recording_duration integer required
console_error_count integer required
mouse_activity_count integer required

Responses

200 —
POST /api/projects/{project_id}/session_recordings/{id}/summarize
GET /api/projects/{project_id}/session_recordings/{recording_id}/sharing
operationId: Sessionrecordings_getSharing

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
recording_id path required string —

Responses

200 —
GET /api/projects/{project_id}/session_recordings/{recording_id}/sharing

Subscriptions 6 endpoints

GET /api/projects/{project_id}/subscriptions
operationId: subscriptions_list

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/subscriptions
POST /api/projects/{project_id}/subscriptions
operationId: subscriptions_create

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

required
application/json
schema Subscription
Property Type Required
id integer required
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string required
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string required
until_date string optional
target_type string required
target_value string required
invite_message string optional
next_delivery_date string required
multipart/form-data
schema Subscription
Property Type Required
id integer required
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string required
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string required
until_date string optional
target_type string required
target_value string required
invite_message string optional
next_delivery_date string required
application/x-www-form-urlencoded
schema Subscription
Property Type Required
id integer required
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string required
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string required
until_date string optional
target_type string required
target_value string required
invite_message string optional
next_delivery_date string required

Responses

201 —
POST /api/projects/{project_id}/subscriptions
DELETE /api/projects/{project_id}/subscriptions/{id}

Hard delete of this model is not allowed. Use a patch API call to set “deleted” to true

operationId: subscriptions_destroy

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this subscription.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

default

No response body
DELETE /api/projects/{project_id}/subscriptions/{id}
GET /api/projects/{project_id}/subscriptions/{id}
operationId: subscriptions_retrieve

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this subscription.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/subscriptions/{id}
PATCH /api/projects/{project_id}/subscriptions/{id}
operationId: Subscriptions_updateById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this subscription.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

application/json
schema PatchedSubscription
Property Type Required
id integer optional
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string optional
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
until_date string optional
target_type string optional
target_value string optional
invite_message string optional
next_delivery_date string optional
multipart/form-data
schema PatchedSubscription
Property Type Required
id integer optional
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string optional
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
until_date string optional
target_type string optional
target_value string optional
invite_message string optional
next_delivery_date string optional
application/x-www-form-urlencoded
schema PatchedSubscription
Property Type Required
id integer optional
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string optional
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
until_date string optional
target_type string optional
target_value string optional
invite_message string optional
next_delivery_date string optional

Responses

200 —
PATCH /api/projects/{project_id}/subscriptions/{id}
PUT /api/projects/{project_id}/subscriptions/{id}
operationId: subscriptions_update

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this subscription.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

required
application/json
schema Subscription
Property Type Required
id integer required
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string required
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string required
until_date string optional
target_type string required
target_value string required
invite_message string optional
next_delivery_date string required
multipart/form-data
schema Subscription
Property Type Required
id integer required
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string required
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string required
until_date string optional
target_type string required
target_value string required
invite_message string optional
next_delivery_date string required
application/x-www-form-urlencoded
schema Subscription
Property Type Required
id integer required
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string required
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string required
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string required
until_date string optional
target_type string required
target_value string required
invite_message string optional
next_delivery_date string required

Responses

200 —
PUT /api/projects/{project_id}/subscriptions/{id}

Surveys 7 endpoints

GET /api/projects/{project_id}/surveys
operationId: surveys_list

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/surveys
POST /api/projects/{project_id}/surveys
operationId: surveys_create

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

required
application/json
schema SurveySerializerCreateUpdateOnly
Property Type Required
id string required
name string required
type string required
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional
multipart/form-data
schema SurveySerializerCreateUpdateOnly
Property Type Required
id string required
name string required
type string required
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional
application/x-www-form-urlencoded
schema SurveySerializerCreateUpdateOnly
Property Type Required
id string required
name string required
type string required
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional

Responses

201 —
POST /api/projects/{project_id}/surveys
GET /api/projects/{project_id}/surveys/responses_count
operationId: Surveys_getResponsesCount

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/surveys/responses_count
DELETE /api/projects/{project_id}/surveys/{id}
operationId: surveys_destroy

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this survey.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

204

No response body
DELETE /api/projects/{project_id}/surveys/{id}
GET /api/projects/{project_id}/surveys/{id}
operationId: surveys_retrieve

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this survey.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Responses

200 —
GET /api/projects/{project_id}/surveys/{id}
PATCH /api/projects/{project_id}/surveys/{id}
operationId: Surveys_updateSurveyById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this survey.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

application/json
schema PatchedSurveySerializerCreateUpdateOnly
Property Type Required
id string optional
name string optional
type string optional
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional
multipart/form-data
schema PatchedSurveySerializerCreateUpdateOnly
Property Type Required
id string optional
name string optional
type string optional
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional
application/x-www-form-urlencoded
schema PatchedSurveySerializerCreateUpdateOnly
Property Type Required
id string optional
name string optional
type string optional
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional

Responses

200 —
PATCH /api/projects/{project_id}/surveys/{id}
PUT /api/projects/{project_id}/surveys/{id}
operationId: surveys_update

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this survey.
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

required
application/json
schema Survey
Property Type Required
id string required
name string required
type string required
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
multipart/form-data
schema Survey
Property Type Required
id string required
name string required
type string required
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
application/x-www-form-urlencoded
schema Survey
Property Type Required
id string required
name string required
type string required
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string required
created_by object required
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object required
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional

Responses

200 —
PUT /api/projects/{project_id}/surveys/{id}

Trend 1 endpoints

POST /api/projects/{project_id}/insights/trend
operationId: Trend_createOrUpdatePath

Parameters

Name In Required Type Description
format query optional string —
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Request Body

application/json
schema Trend
Property Type Required
events array optional
└ id string required
└ math string optional
└ properties array optional
└ type string optional
└ values array required
└ key string required
└ type object optional
└ value string required
└ operator object optional
actions array optional
└ id string required
└ math string optional
└ properties array optional
└ type string optional
└ values array required
└ key string required
└ type object optional
└ value string required
└ operator object optional
compare boolean optional
date_to string optional
display string optional
formula string optional
breakdown string optional
date_from string optional
properties object optional
└ type string optional
└ values array required
└ key string required
└ type object optional
└ value string required
└ operator object optional
breakdown_type string optional
filter_test_accounts boolean optional

Responses

200 —
POST /api/projects/{project_id}/insights/trend

Users 9 endpoints

GET /api/users
operationId: users_list

Parameters

Name In Required Type Description
is_staff query optional boolean —
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.

Responses

200 —
GET /api/users
GET /api/users/{uuid}
operationId: users_retrieve

Parameters

Name In Required Type Description
uuid path required string —

Responses

200 —
GET /api/users/{uuid}
PATCH /api/users/{uuid}
operationId: Users_patchUuid

Parameters

Name In Required Type Description
uuid path required string —

Request Body

application/json
schema PatchedUser
Property Type Required
team object optional
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string optional
email string optional
is_staff boolean optional
password string optional
last_name string optional
first_name string optional
theme_mode object optional
date_joined string optional
distinct_id string optional
email_opt_in boolean optional
has_password boolean optional
organization object optional
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array optional
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
is_impersonated boolean optional
…8 more object optional
multipart/form-data
schema PatchedUser
Property Type Required
team object optional
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string optional
email string optional
is_staff boolean optional
password string optional
last_name string optional
first_name string optional
theme_mode object optional
date_joined string optional
distinct_id string optional
email_opt_in boolean optional
has_password boolean optional
organization object optional
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array optional
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
is_impersonated boolean optional
…8 more object optional
application/x-www-form-urlencoded
schema PatchedUser
Property Type Required
team object optional
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string optional
email string optional
is_staff boolean optional
password string optional
last_name string optional
first_name string optional
theme_mode object optional
date_joined string optional
distinct_id string optional
email_opt_in boolean optional
has_password boolean optional
organization object optional
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array optional
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
is_impersonated boolean optional
…8 more object optional

Responses

200 —
PATCH /api/users/{uuid}
PUT /api/users/{uuid}
operationId: users_update

Parameters

Name In Required Type Description
uuid path required string —

Request Body

required
application/json
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
multipart/form-data
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
application/x-www-form-urlencoded
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional

Responses

200 —
PUT /api/users/{uuid}
POST /api/users/{uuid}/request_email_verification
operationId: Users_requestEmailVerificationCreate

Parameters

Name In Required Type Description
uuid path required string —

Request Body

required
application/json
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
multipart/form-data
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
application/x-www-form-urlencoded
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional

Responses

200 —
POST /api/users/{uuid}/request_email_verification
POST /api/users/{uuid}/scene_personalisation
operationId: Users_createScenePersonalisation

Parameters

Name In Required Type Description
uuid path required string —

Request Body

required
application/json
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
multipart/form-data
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
application/x-www-form-urlencoded
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional

Responses

200 —
POST /api/users/{uuid}/scene_personalisation
GET /api/users/{uuid}/start_2fa_setup
operationId: Users_start2faSetupRetrieve

Parameters

Name In Required Type Description
uuid path required string —

Responses

200 —
GET /api/users/{uuid}/start_2fa_setup
POST /api/users/{uuid}/validate_2fa
operationId: Users_validate2faCreate

Parameters

Name In Required Type Description
uuid path required string —

Request Body

required
application/json
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
multipart/form-data
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
application/x-www-form-urlencoded
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional

Responses

200 —
POST /api/users/{uuid}/validate_2fa
POST /api/users/{uuid}/verify_email
operationId: Users_verifyEmailCreate

Parameters

Name In Required Type Description
uuid path required string —

Request Body

required
application/json
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
multipart/form-data
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional
application/x-www-form-urlencoded
schema User
Property Type Required
team object required
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string required
email string required
is_staff boolean optional
password string required
last_name string optional
first_name string optional
theme_mode object optional
date_joined string required
distinct_id string optional
email_opt_in boolean optional
has_password boolean required
organization object required
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array required
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean required
has_social_auth boolean required
is_impersonated boolean required
…8 more object optional

Responses

200 —
POST /api/users/{uuid}/verify_email