diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 13850161174bf..4f882f4a85eac 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -9882,6 +9882,140 @@ menu: - ListPermissions unstable: [] order: 1 + - name: Rum Audience Management + url: /api/latest/rum-audience-management/ + identifier: rum-audience-management + generated: true + - name: List connections + url: '#list-connections' + identifier: rum-audience-management-list-connections + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - ListConnections + unstable: + - v2 + order: 7 + - name: Delete connection + url: '#delete-connection' + identifier: rum-audience-management-delete-connection + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - DeleteConnection + unstable: + - v2 + order: 6 + - name: Update connection + url: '#update-connection' + identifier: rum-audience-management-update-connection + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - UpdateConnection + unstable: + - v2 + order: 3 + - name: Create connection + url: '#create-connection' + identifier: rum-audience-management-create-connection + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - CreateConnection + unstable: + - v2 + order: 2 + - name: Get mapping + url: '#get-mapping' + identifier: rum-audience-management-get-mapping + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - GetMapping + unstable: + - v2 + order: 10 + - name: Query users + url: '#query-users' + identifier: rum-audience-management-query-users + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - QueryUsers + unstable: + - v2 + order: 8 + - name: Get user facet info + url: '#get-user-facet-info' + identifier: rum-audience-management-get-user-facet-info + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - GetUserFacetInfo + unstable: + - v2 + order: 9 + - name: Query event filtered users + url: '#query-event-filtered-users' + identifier: rum-audience-management-query-event-filtered-users + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - QueryEventFilteredUsers + unstable: + - v2 + order: 4 + - name: Query accounts + url: '#query-accounts' + identifier: rum-audience-management-query-accounts + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - QueryAccounts + unstable: + - v2 + order: 1 + - name: Get account facet info + url: '#get-account-facet-info' + identifier: rum-audience-management-get-account-facet-info + parent: rum-audience-management + generated: true + params: + versions: + - v2 + operationids: + - GetAccountFacetInfo + unstable: + - v2 + order: 5 - name: Rum Metrics url: /api/latest/rum-metrics/ identifier: rum-metrics diff --git a/content/en/api/latest/rum-audience-management/_index.md b/content/en/api/latest/rum-audience-management/_index.md new file mode 100644 index 0000000000000..d5d991b6ccadf --- /dev/null +++ b/content/en/api/latest/rum-audience-management/_index.md @@ -0,0 +1,3 @@ +--- +title: Rum Audience Management +--- diff --git a/content/en/api/v2/rum-audience-management/_index.md b/content/en/api/v2/rum-audience-management/_index.md new file mode 100644 index 0000000000000..b10955e036d58 --- /dev/null +++ b/content/en/api/v2/rum-audience-management/_index.md @@ -0,0 +1,4 @@ +--- +title: Rum Audience Management +headless: true +--- diff --git a/content/en/api/v2/rum-audience-management/examples.json b/content/en/api/v2/rum-audience-management/examples.json new file mode 100644 index 0000000000000..df9269cfaced1 --- /dev/null +++ b/content/en/api/v2/rum-audience-management/examples.json @@ -0,0 +1,695 @@ +{ + "GetAccountFacetInfo": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

range

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

max

\n
\n

object

\n
\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

object

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

values

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users facet info resource type. \nAllowed enum values: users_facet_info

default: users_facet_info

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "facet_id": "", + "limit": 0 + }, + "type": "users_facet_info_request" + } + }, + "json": { + "data": { + "attributes": { + "facet_id": "", + "limit": 0, + "search": { + "query": "string" + }, + "term_search": { + "value": "string" + } + }, + "id": "string", + "type": "users_facet_info_request" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

facet_id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

limit [required]

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

query

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

term_search

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

value

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users facet info request resource type. \nAllowed enum values: users_facet_info_request

default: users_facet_info_request

\n
\n \n
\n
\n
\n
" + } + }, + "QueryAccounts": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

hits

\n
\n

[]

\n
\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Query response resource type. \nAllowed enum values: query_response

default: query_response

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "query_account_request" + } + }, + "json": { + "data": { + "attributes": { + "limit": "integer", + "query": "string", + "select_columns": [], + "sort": { + "field": "string", + "order": "string" + }, + "wildcard_search_term": "string" + }, + "id": "string", + "type": "query_account_request" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

select_columns

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

wildcard_search_term

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Query account request resource type. \nAllowed enum values: query_account_request

default: query_account_request

\n
\n \n
\n
\n
\n
" + } + }, + "QueryEventFilteredUsers": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

hits

\n
\n

[]

\n
\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Query response resource type. \nAllowed enum values: query_response

default: query_response

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "query_event_filtered_users_request" + } + }, + "json": { + "data": { + "attributes": { + "event_query": { + "query": "string", + "time_frame": { + "end": "integer", + "start": "integer" + } + }, + "include_row_count": false, + "limit": "integer", + "query": "string", + "select_columns": [] + }, + "id": "string", + "type": "query_event_filtered_users_request" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

event_query

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

query

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

time_frame

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_row_count

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

select_columns

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Query event filtered users request resource type. \nAllowed enum values: query_event_filtered_users_request

default: query_event_filtered_users_request

\n
\n \n
\n
\n
\n
" + } + }, + "GetUserFacetInfo": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

range

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

max

\n
\n

object

\n
\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

object

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

values

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users facet info resource type. \nAllowed enum values: users_facet_info

default: users_facet_info

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "facet_id": "", + "limit": 0 + }, + "type": "users_facet_info_request" + } + }, + "json": { + "data": { + "attributes": { + "facet_id": "", + "limit": 0, + "search": { + "query": "string" + }, + "term_search": { + "value": "string" + } + }, + "id": "string", + "type": "users_facet_info_request" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

facet_id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

limit [required]

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

query

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

term_search

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

value

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users facet info request resource type. \nAllowed enum values: users_facet_info_request

default: users_facet_info_request

\n
\n \n
\n
\n
\n
" + } + }, + "QueryUsers": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

hits

\n
\n

[]

\n
\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Query response resource type. \nAllowed enum values: query_response

default: query_response

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "query_users_request" + } + }, + "json": { + "data": { + "attributes": { + "limit": "integer", + "query": "string", + "select_columns": [], + "sort": { + "field": "string", + "order": "string" + }, + "wildcard_search_term": "string" + }, + "id": "string", + "type": "query_users_request" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

select_columns

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

wildcard_search_term

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Query users request resource type. \nAllowed enum values: query_users_request

default: query_users_request

\n
\n \n
\n
\n
\n
" + } + }, + "GetMapping": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "attributes": [ + { + "attribute": "user_id", + "description": "Unique user identifier", + "display_name": "User ID", + "groups": [ + "Identity" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "user_email", + "description": "User email address", + "display_name": "Email Address", + "groups": [ + "Identity", + "Contact" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "first_country_code", + "description": "The ISO code of the country for the user's first session", + "display_name": "First Country Code", + "groups": [ + "Geography" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "@customer_tier", + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business" + ], + "is_custom": true, + "type": "string" + } + ] + }, + "id": "get_mappings_response", + "type": "get_mappings_response" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

groups

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n

is_custom

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Get mappings response resource type. \nAllowed enum values: get_mappings_response

default: get_mappings_response

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateConnection": { + "responses": { + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "fields": [ + { + "id": "", + "source_name": "", + "type": "" + } + ], + "join_attribute": "", + "join_type": "", + "type": "" + }, + "type": "connection_id" + } + }, + "json": { + "data": { + "attributes": { + "fields": [ + { + "description": "string", + "display_name": "string", + "groups": [], + "id": "", + "source_name": "", + "type": "" + } + ], + "join_attribute": "", + "join_type": "", + "metadata": { + "": "string" + }, + "type": "" + }, + "id": "string", + "type": "connection_id" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

fields

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

groups

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

source_name [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

join_attribute [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

join_type [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Connection id resource type. \nAllowed enum values: connection_id

default: connection_id

\n
\n \n
\n
\n
\n
" + } + }, + "UpdateConnection": { + "responses": { + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "fields_to_add": [ + { + "id": "", + "source_name": "", + "type": "" + } + ], + "fields_to_update": [ + { + "field_id": "" + } + ] + }, + "id": "", + "type": "connection_id" + } + }, + "json": { + "data": { + "attributes": { + "fields_to_add": [ + { + "description": "string", + "display_name": "string", + "groups": [], + "id": "", + "source_name": "", + "type": "" + } + ], + "fields_to_delete": [], + "fields_to_update": [ + { + "field_id": "", + "updated_description": "string", + "updated_display_name": "string", + "updated_field_id": "string", + "updated_groups": [] + } + ] + }, + "id": "", + "type": "connection_id" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

fields_to_add

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

groups

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

source_name [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fields_to_delete

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n

fields_to_update

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

field_id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

updated_description

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

updated_display_name

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

updated_field_id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

updated_groups

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Connection id resource type. \nAllowed enum values: connection_id

default: connection_id

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteConnection": { + "responses": { + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "ListConnections": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "connections": [ + { + "created_at": "0001-01-01T00:00:00Z", + "created_by": "00000000-0000-0000-0000-000000000000", + "fields": [ + { + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business", + "Subscription" + ], + "id": "customer_tier", + "source_name": "subscription_tier", + "type": "string" + }, + { + "description": "Channel through which user signed up", + "display_name": "Signup Source", + "groups": [ + "Marketing", + "Attribution" + ], + "id": "signup_source", + "source_name": "acquisition_channel", + "type": "string" + } + ], + "id": "user-profiles-connection", + "join": { + "attribute": "user_email", + "type": "email" + }, + "type": "ref_table", + "updated_at": "0001-01-01T00:00:00Z", + "updated_by": "00000000-0000-0000-0000-000000000000" + } + ] + }, + "id": "list_connections_response", + "type": "list_connections_response" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n
\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

groups

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

source_name [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

join

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n
\n
\n \n
\n
\n
\n
\n
\n

updated_by

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

List connections response resource type. \nAllowed enum values: list_connections_response

default: list_connections_response

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index d93fb63abd501..a15977619b69f 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -12488,6 +12488,89 @@ components: required: - type type: object + CreateConnectionRequest: + example: + data: + attributes: + fields: + - description: Customer subscription tier from `CRM` + display_name: Customer Tier + id: customer_tier + source_name: subscription_tier + type: string + - description: Customer lifetime value in `USD` + display_name: Lifetime Value + id: lifetime_value + source_name: ltv + type: number + join_attribute: user_email + join_type: email + type: ref_table + id: crm-integration + type: connection_id + properties: + data: + $ref: '#/components/schemas/CreateConnectionRequestData' + type: object + CreateConnectionRequestData: + properties: + attributes: + $ref: '#/components/schemas/CreateConnectionRequestDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/UpdateConnectionRequestDataType' + required: + - type + type: object + CreateConnectionRequestDataAttributes: + properties: + fields: + items: + $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems' + type: array + join_attribute: + example: '' + type: string + join_type: + example: '' + type: string + metadata: + additionalProperties: + type: string + type: object + type: + example: '' + type: string + required: + - join_attribute + - join_type + - type + type: object + CreateConnectionRequestDataAttributesFieldsItems: + properties: + description: + type: string + display_name: + type: string + groups: + items: + type: string + type: array + id: + example: '' + type: string + source_name: + example: '' + type: string + type: + example: '' + type: string + required: + - id + - source_name + - type + type: object CreateCustomFrameworkRequest: description: Request object to create a custom framework. properties: @@ -19725,6 +19808,140 @@ components: x-enum-varnames: - ADD - REPLACE + FacetInfoRequest: + example: + data: + attributes: + facet_id: first_browser_name + limit: 10 + search: + query: user_org_id:5001 AND first_country_code:US + term_search: + value: Chrome + id: facet_info_request + type: users_facet_info_request + properties: + data: + $ref: '#/components/schemas/FacetInfoRequestData' + type: object + FacetInfoRequestData: + properties: + attributes: + $ref: '#/components/schemas/FacetInfoRequestDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/FacetInfoRequestDataType' + required: + - type + type: object + FacetInfoRequestDataAttributes: + properties: + facet_id: + example: '' + type: string + limit: + example: 0 + format: int64 + type: integer + search: + $ref: '#/components/schemas/FacetInfoRequestDataAttributesSearch' + term_search: + $ref: '#/components/schemas/FacetInfoRequestDataAttributesTermSearch' + required: + - facet_id + - limit + type: object + FacetInfoRequestDataAttributesSearch: + properties: + query: + type: string + type: object + FacetInfoRequestDataAttributesTermSearch: + properties: + value: + type: string + type: object + FacetInfoRequestDataType: + default: users_facet_info_request + description: Users facet info request resource type. + enum: + - users_facet_info_request + example: users_facet_info_request + type: string + x-enum-varnames: + - USERS_FACET_INFO_REQUEST + FacetInfoResponse: + example: + data: + attributes: + result: + values: + - count: 4892 + value: Chrome + - count: 2341 + value: Safari + - count: 1567 + value: Firefox + - count: 892 + value: Edge + - count: 234 + value: Opera + id: facet_info_response + type: users_facet_info + properties: + data: + $ref: '#/components/schemas/FacetInfoResponseData' + type: object + FacetInfoResponseData: + properties: + attributes: + $ref: '#/components/schemas/FacetInfoResponseDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/FacetInfoResponseDataType' + required: + - type + type: object + FacetInfoResponseDataAttributes: + properties: + result: + $ref: '#/components/schemas/FacetInfoResponseDataAttributesResult' + type: object + FacetInfoResponseDataAttributesResult: + properties: + range: + $ref: '#/components/schemas/FacetInfoResponseDataAttributesResultRange' + values: + items: + $ref: '#/components/schemas/FacetInfoResponseDataAttributesResultValuesItems' + type: array + type: object + FacetInfoResponseDataAttributesResultRange: + properties: + max: + type: object + min: + type: object + type: object + FacetInfoResponseDataAttributesResultValuesItems: + properties: + count: + format: int64 + type: integer + value: + type: string + type: object + FacetInfoResponseDataType: + default: users_facet_info + description: Users facet info resource type. + enum: + - users_facet_info + example: users_facet_info + type: string + x-enum-varnames: + - USERS_FACET_INFO FastlyAPIKey: description: The definition of the `FastlyAPIKey` object. properties: @@ -22102,6 +22319,90 @@ components: - ASSIGNEE - CASE - TEAM_OWNERS + GetMappingResponse: + example: + data: + attributes: + attributes: + - attribute: user_id + description: Unique user identifier + display_name: User ID + groups: + - Identity + is_custom: false + type: string + - attribute: user_email + description: User email address + display_name: Email Address + groups: + - Identity + - Contact + is_custom: false + type: string + - attribute: first_country_code + description: The ISO code of the country for the user's first session + display_name: First Country Code + groups: + - Geography + is_custom: false + type: string + - attribute: '@customer_tier' + description: Customer subscription tier + display_name: Customer Tier + groups: + - Business + is_custom: true + type: string + id: get_mappings_response + type: get_mappings_response + properties: + data: + $ref: '#/components/schemas/GetMappingResponseData' + type: object + GetMappingResponseData: + properties: + attributes: + $ref: '#/components/schemas/GetMappingResponseDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/GetMappingResponseDataType' + required: + - type + type: object + GetMappingResponseDataAttributes: + properties: + attributes: + items: + $ref: '#/components/schemas/GetMappingResponseDataAttributesAttributesItems' + type: array + type: object + GetMappingResponseDataAttributesAttributesItems: + properties: + attribute: + type: string + description: + type: string + display_name: + type: string + groups: + items: + type: string + type: array + is_custom: + type: boolean + type: + type: string + type: object + GetMappingResponseDataType: + default: get_mappings_response + description: Get mappings response resource type. + enum: + - get_mappings_response + example: get_mappings_response + type: string + x-enum-varnames: + - GET_MAPPINGS_RESPONSE GetMultipleRulesetsRequest: properties: data: @@ -27750,6 +28051,104 @@ components: required: - data type: object + ListConnectionsResponse: + example: + data: + attributes: + connections: + - created_at: '0001-01-01T00:00:00Z' + created_by: 00000000-0000-0000-0000-000000000000 + fields: + - description: Customer subscription tier + display_name: Customer Tier + groups: + - Business + - Subscription + id: customer_tier + source_name: subscription_tier + type: string + - description: Channel through which user signed up + display_name: Signup Source + groups: + - Marketing + - Attribution + id: signup_source + source_name: acquisition_channel + type: string + id: user-profiles-connection + join: + attribute: user_email + type: email + type: ref_table + updated_at: '0001-01-01T00:00:00Z' + updated_by: 00000000-0000-0000-0000-000000000000 + id: list_connections_response + type: list_connections_response + properties: + data: + $ref: '#/components/schemas/ListConnectionsResponseData' + type: object + ListConnectionsResponseData: + properties: + attributes: + $ref: '#/components/schemas/ListConnectionsResponseDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/ListConnectionsResponseDataType' + required: + - type + type: object + ListConnectionsResponseDataAttributes: + properties: + connections: + items: + $ref: '#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItems' + type: array + type: object + ListConnectionsResponseDataAttributesConnectionsItems: + properties: + created_at: + format: date-time + type: string + created_by: + type: string + fields: + items: + $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems' + type: array + id: + type: string + join: + $ref: '#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItemsJoin' + metadata: + additionalProperties: + type: string + type: object + type: + type: string + updated_at: + format: date-time + type: string + updated_by: + type: string + type: object + ListConnectionsResponseDataAttributesConnectionsItemsJoin: + properties: + attribute: + type: string + type: + type: string + type: object + ListConnectionsResponseDataType: + default: list_connections_response + description: List connections response resource type. + enum: + - list_connections_response + example: list_connections_response + type: string + x-enum-varnames: + - LIST_CONNECTIONS_RESPONSE ListDevicesResponse: description: List devices response. properties: @@ -38460,6 +38859,153 @@ components: - $ref: '#/components/schemas/ActionQuery' - $ref: '#/components/schemas/DataTransform' - $ref: '#/components/schemas/StateVariable' + QueryAccountRequest: + example: + data: + attributes: + limit: 20 + query: plan_type:enterprise AND user_count:>100 AND subscription_status:active + select_columns: + - account_id + - account_name + - user_count + - plan_type + - subscription_status + - created_at + - mrr + - industry + sort: + field: user_count + order: DESC + wildcard_search_term: tech + id: query_account_request + type: query_account_request + properties: + data: + $ref: '#/components/schemas/QueryAccountRequestData' + type: object + QueryAccountRequestData: + properties: + attributes: + $ref: '#/components/schemas/QueryAccountRequestDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/QueryAccountRequestDataType' + required: + - type + type: object + QueryAccountRequestDataAttributes: + properties: + limit: + format: int64 + type: integer + query: + type: string + select_columns: + items: + type: string + type: array + sort: + $ref: '#/components/schemas/QueryAccountRequestDataAttributesSort' + wildcard_search_term: + type: string + type: object + QueryAccountRequestDataAttributesSort: + properties: + field: + type: string + order: + type: string + type: object + QueryAccountRequestDataType: + default: query_account_request + description: Query account request resource type. + enum: + - query_account_request + example: query_account_request + type: string + x-enum-varnames: + - QUERY_ACCOUNT_REQUEST + QueryEventFilteredUsersRequest: + example: + data: + attributes: + event_query: + query: '@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform' + time_frame: + end: 1761309676 + start: 1760100076 + include_row_count: true + limit: 25 + query: user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome + select_columns: + - user_id + - user_email + - first_country_code + - first_browser_name + - events_count + - session_count + - error_count + - avg_loading_time + id: query_event_filtered_users_request + type: query_event_filtered_users_request + properties: + data: + $ref: '#/components/schemas/QueryEventFilteredUsersRequestData' + type: object + QueryEventFilteredUsersRequestData: + properties: + attributes: + $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataType' + required: + - type + type: object + QueryEventFilteredUsersRequestDataAttributes: + properties: + event_query: + $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQuery' + include_row_count: + type: boolean + limit: + format: int64 + type: integer + query: + type: string + select_columns: + items: + type: string + type: array + type: object + QueryEventFilteredUsersRequestDataAttributesEventQuery: + properties: + query: + type: string + time_frame: + $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame' + type: object + QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame: + properties: + end: + format: int64 + type: integer + start: + format: int64 + type: integer + type: object + QueryEventFilteredUsersRequestDataType: + default: query_event_filtered_users_request + description: Query event filtered users request resource type. + enum: + - query_event_filtered_users_request + example: query_event_filtered_users_request + type: string + x-enum-varnames: + - QUERY_EVENT_FILTERED_USERS_REQUEST QueryFormula: description: A formula for calculation based on one or more queries. properties: @@ -38473,6 +39019,81 @@ components: required: - formula type: object + QueryResponse: + example: + data: + attributes: + hits: + - first_browser_name: Chrome + first_city: San Francisco + first_country_code: US + first_device_type: Desktop + last_seen: '2025-08-14T06:45:12.142Z' + session_count: 47 + user_created: '2024-12-15T08:42:33.287Z' + user_email: john.smith@techcorp.com + user_id: '150847' + user_name: John Smith + user_org_id: '5001' + - first_browser_name: Chrome + first_city: Austin + first_country_code: US + first_device_type: Desktop + last_seen: '2025-08-14T05:22:08.951Z' + session_count: 89 + user_created: '2024-11-28T14:17:45.634Z' + user_email: john.williams@techcorp.com + user_id: '150848' + user_name: John Williams + user_org_id: '5001' + - first_browser_name: Chrome + first_city: Seattle + first_country_code: US + first_device_type: Desktop + last_seen: '2025-08-14T04:18:34.726Z' + session_count: 23 + user_created: '2025-01-03T16:33:21.445Z' + user_email: john.jones@techcorp.com + user_id: '150849' + user_name: John Jones + user_org_id: '5001' + total: 147 + id: query_response + type: query_response + properties: + data: + $ref: '#/components/schemas/QueryResponseData' + type: object + QueryResponseData: + properties: + attributes: + $ref: '#/components/schemas/QueryResponseDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/QueryResponseDataType' + required: + - type + type: object + QueryResponseDataAttributes: + properties: + hits: + items: + additionalProperties: {} + type: array + total: + format: int64 + type: integer + type: object + QueryResponseDataType: + default: query_response + description: Query response resource type. + enum: + - query_response + example: query_response + type: string + x-enum-varnames: + - QUERY_RESPONSE QuerySortOrder: default: desc description: Direction of sort. @@ -38483,6 +39104,74 @@ components: x-enum-varnames: - ASC - DESC + QueryUsersRequest: + example: + data: + attributes: + limit: 25 + query: user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome + select_columns: + - user_id + - user_email + - user_name + - user_org_id + - first_country_code + - first_browser_name + - first_device_type + - last_seen + sort: + field: first_seen + order: DESC + wildcard_search_term: john + id: query_users_request + type: query_users_request + properties: + data: + $ref: '#/components/schemas/QueryUsersRequestData' + type: object + QueryUsersRequestData: + properties: + attributes: + $ref: '#/components/schemas/QueryUsersRequestDataAttributes' + id: + type: string + type: + $ref: '#/components/schemas/QueryUsersRequestDataType' + required: + - type + type: object + QueryUsersRequestDataAttributes: + properties: + limit: + format: int64 + type: integer + query: + type: string + select_columns: + items: + type: string + type: array + sort: + $ref: '#/components/schemas/QueryUsersRequestDataAttributesSort' + wildcard_search_term: + type: string + type: object + QueryUsersRequestDataAttributesSort: + properties: + field: + type: string + order: + type: string + type: object + QueryUsersRequestDataType: + default: query_users_request + description: Query users request resource type. + enum: + - query_users_request + example: query_users_request + type: string + x-enum-varnames: + - QUERY_USERS_REQUEST RUMAggregateBucketValue: description: A bucket value, can be either a timeseries or a single value. oneOf: @@ -52516,6 +53205,88 @@ components: description: The display name of the datastore. type: string type: object + UpdateConnectionRequest: + example: + data: + attributes: + fields_to_add: + - description: Net Promoter Score from customer surveys + display_name: NPS Score + groups: + - Satisfaction + - Metrics + id: nps_score + source_name: net_promoter_score + type: number + fields_to_delete: + - old_revenue_field + fields_to_update: + - field_id: lifetime_value + updated_display_name: Customer Lifetime Value (`USD`) + updated_groups: + - Financial + - Metrics + id: crm-integration + type: connection_id + properties: + data: + $ref: '#/components/schemas/UpdateConnectionRequestData' + type: object + UpdateConnectionRequestData: + properties: + attributes: + $ref: '#/components/schemas/UpdateConnectionRequestDataAttributes' + id: + example: '' + type: string + type: + $ref: '#/components/schemas/UpdateConnectionRequestDataType' + required: + - type + - id + type: object + UpdateConnectionRequestDataAttributes: + properties: + fields_to_add: + items: + $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems' + type: array + fields_to_delete: + items: + type: string + type: array + fields_to_update: + items: + $ref: '#/components/schemas/UpdateConnectionRequestDataAttributesFieldsToUpdateItems' + type: array + type: object + UpdateConnectionRequestDataAttributesFieldsToUpdateItems: + properties: + field_id: + example: '' + type: string + updated_description: + type: string + updated_display_name: + type: string + updated_field_id: + type: string + updated_groups: + items: + type: string + type: array + required: + - field_id + type: object + UpdateConnectionRequestDataType: + default: connection_id + description: Connection id resource type. + enum: + - connection_id + example: connection_id + type: string + x-enum-varnames: + - CONNECTION_ID UpdateCustomFrameworkRequest: description: Request object to update a custom framework. properties: @@ -72028,6 +72799,308 @@ paths: x-permission: operator: OPEN permissions: [] + /api/v2/product-analytics/accounts/facet_info: + post: + description: Get facet information for account attributes including possible + values and counts + operationId: GetAccountFacetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FacetInfoRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FacetInfoResponse' + description: Successful response with facet information + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get account facet info + tags: + - Rum Audience Management + x-menu-order: 5 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/accounts/query: + post: + description: Query accounts with flexible filtering by account properties + operationId: QueryAccounts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryAccountRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + description: Successful response with account data + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Query accounts + tags: + - Rum Audience Management + x-menu-order: 1 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/users/event_filtered_query: + post: + description: Query users filtered by both user properties and event platform + data + operationId: QueryEventFilteredUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryEventFilteredUsersRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + description: Successful response with filtered user data + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Query event filtered users + tags: + - Rum Audience Management + x-menu-order: 4 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/users/facet_info: + post: + description: Get facet information for user attributes including possible values + and counts + operationId: GetUserFacetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FacetInfoRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FacetInfoResponse' + description: Successful response with facet information + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get user facet info + tags: + - Rum Audience Management + x-menu-order: 9 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/users/query: + post: + description: Query users with flexible filtering by user properties, with optional + wildcard search + operationId: QueryUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryUsersRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + description: Successful response with user data + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Query users + tags: + - Rum Audience Management + x-menu-order: 8 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/{entity}/mapping: + get: + description: Get entity mapping configuration including all available attributes + and their properties + operationId: GetMapping + parameters: + - description: The entity for which to get the mapping + in: path + name: entity + required: true + schema: + example: users + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetMappingResponse' + description: Successful response with entity mapping configuration + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get mapping + tags: + - Rum Audience Management + x-menu-order: 10 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/{entity}/mapping/connection: + post: + description: Create a new data connection and its fields for an entity + operationId: CreateConnection + parameters: + - description: The entity for which to create the connection + in: path + name: entity + required: true + schema: + example: users + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateConnectionRequest' + required: true + responses: + '201': + description: Connection created successfully + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Create connection + tags: + - Rum Audience Management + x-menu-order: 2 + x-unstable: '**Note**: This endpoint may be subject to changes.' + put: + description: Update an existing data connection by adding, updating, or deleting + fields + operationId: UpdateConnection + parameters: + - description: The entity for which to update the connection + in: path + name: entity + required: true + schema: + example: users + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConnectionRequest' + required: true + responses: + '200': + description: Connection updated successfully + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Update connection + tags: + - Rum Audience Management + x-menu-order: 3 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/{entity}/mapping/connection/{id}: + delete: + description: Delete an existing data connection for an entity + operationId: DeleteConnection + parameters: + - description: The connection ID to delete + in: path + name: id + required: true + schema: + example: connection-id-123 + type: string + - description: The entity for which to delete the connection + in: path + name: entity + required: true + schema: + example: users + type: string + responses: + '204': + description: Connection deleted successfully + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Delete connection + tags: + - Rum Audience Management + x-menu-order: 6 + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/product-analytics/{entity}/mapping/connections: + get: + description: List all data connections for an entity + operationId: ListConnections + parameters: + - description: The entity for which to list connections + in: path + name: entity + required: true + schema: + example: users + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListConnectionsResponse' + description: Successful response with list of connections + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: List connections + tags: + - Rum Audience Management + x-menu-order: 7 + x-unstable: '**Note**: This endpoint may be subject to changes.' /api/v2/query/scalar: post: description: 'Query scalar values (as seen on Query Value, Table, and Toplist @@ -83700,6 +84773,8 @@ tags: [Pipelines page](https://app.datadoghq.com/logs/pipelines).' name: Roles +- description: Auto-generated tag Rum Audience Management + name: Rum Audience Management - description: Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) for your organization. externalDocs: diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 734568224aea8..0f104cd1ef7d9 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -79938,6 +79938,313 @@ ], "type": "object" }, + "CreateConnectionRequest": { + "example": { + "data": { + "attributes": { + "fields": [ + { + "description": "Customer subscription tier from `CRM`", + "display_name": "Customer Tier", + "id": "customer_tier", + "source_name": "subscription_tier", + "type": "string" + }, + { + "description": "Customer lifetime value in `USD`", + "display_name": "Lifetime Value", + "id": "lifetime_value", + "source_name": "ltv", + "type": "number" + } + ], + "join_attribute": "user_email", + "join_type": "email", + "type": "ref_table" + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "CreateConnectionRequestData": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "CreateConnectionRequestDataAttributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "CreateConnectionRequestDataAttributesFieldsItems": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, "CreateCustomFrameworkRequest": { "description": "Request object to create a custom framework.", "properties": { @@ -121939,6 +122246,460 @@ "REPLACE" ] }, + "FacetInfoRequest": { + "example": { + "data": { + "attributes": { + "facet_id": "first_browser_name", + "limit": 10, + "search": { + "query": "user_org_id:5001 AND first_country_code:US" + }, + "term_search": { + "value": "Chrome" + } + }, + "id": "facet_info_request", + "type": "users_facet_info_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoRequestData": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "FacetInfoRequestDataAttributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "FacetInfoRequestDataAttributesSearch": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "FacetInfoRequestDataAttributesTermSearch": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + }, + "FacetInfoRequestDataType": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + }, + "FacetInfoResponse": { + "example": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoResponseData": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "FacetInfoResponseDataAttributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoResponseDataAttributesResult": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "FacetInfoResponseDataAttributesResultRange": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoResponseDataAttributesResultValuesItems": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "FacetInfoResponseDataType": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + }, "FastlyAPIKey": { "description": "The definition of the `FastlyAPIKey` object.", "properties": { @@ -134745,6 +135506,248 @@ "TEAM_OWNERS" ] }, + "GetMappingResponse": { + "example": { + "data": { + "attributes": { + "attributes": [ + { + "attribute": "user_id", + "description": "Unique user identifier", + "display_name": "User ID", + "groups": [ + "Identity" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "user_email", + "description": "User email address", + "display_name": "Email Address", + "groups": [ + "Identity", + "Contact" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "first_country_code", + "description": "The ISO code of the country for the user's first session", + "display_name": "First Country Code", + "groups": [ + "Geography" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "@customer_tier", + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business" + ], + "is_custom": true, + "type": "string" + } + ] + }, + "id": "get_mappings_response", + "type": "get_mappings_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "GetMappingResponseData": { + "properties": { + "attributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMappingResponseDataAttributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetMappingResponseDataAttributesAttributesItems": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "GetMappingResponseDataType": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + }, "GetMultipleRulesetsRequest": { "properties": { "data": { @@ -185414,6 +186417,466 @@ ], "type": "object" }, + "ListConnectionsResponse": { + "example": { + "data": { + "attributes": { + "connections": [ + { + "created_at": "0001-01-01T00:00:00Z", + "created_by": "00000000-0000-0000-0000-000000000000", + "fields": [ + { + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business", + "Subscription" + ], + "id": "customer_tier", + "source_name": "subscription_tier", + "type": "string" + }, + { + "description": "Channel through which user signed up", + "display_name": "Signup Source", + "groups": [ + "Marketing", + "Attribution" + ], + "id": "signup_source", + "source_name": "acquisition_channel", + "type": "string" + } + ], + "id": "user-profiles-connection", + "join": { + "attribute": "user_email", + "type": "email" + }, + "type": "ref_table", + "updated_at": "0001-01-01T00:00:00Z", + "updated_by": "00000000-0000-0000-0000-000000000000" + } + ] + }, + "id": "list_connections_response", + "type": "list_connections_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "ListConnectionsResponseData": { + "properties": { + "attributes": { + "properties": { + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "ListConnectionsResponseDataAttributes": { + "properties": { + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListConnectionsResponseDataAttributesConnectionsItems": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "ListConnectionsResponseDataAttributesConnectionsItemsJoin": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ListConnectionsResponseDataType": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] + }, "ListDevicesResponse": { "description": "List devices response.", "properties": { @@ -276315,6 +277778,452 @@ } ] }, + "QueryAccountRequest": { + "example": { + "data": { + "attributes": { + "limit": 20, + "query": "plan_type:enterprise AND user_count:>100 AND subscription_status:active", + "select_columns": [ + "account_id", + "account_name", + "user_count", + "plan_type", + "subscription_status", + "created_at", + "mrr", + "industry" + ], + "sort": { + "field": "user_count", + "order": "DESC" + }, + "wildcard_search_term": "tech" + }, + "id": "query_account_request", + "type": "query_account_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryAccountRequestData": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryAccountRequestDataAttributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "QueryAccountRequestDataAttributesSort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "QueryAccountRequestDataType": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + }, + "QueryEventFilteredUsersRequest": { + "example": { + "data": { + "attributes": { + "event_query": { + "query": "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform", + "time_frame": { + "end": 1761309676, + "start": 1760100076 + } + }, + "include_row_count": true, + "limit": 25, + "query": "user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "first_country_code", + "first_browser_name", + "events_count", + "session_count", + "error_count", + "avg_loading_time" + ] + }, + "id": "query_event_filtered_users_request", + "type": "query_event_filtered_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestData": { + "properties": { + "attributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryEventFilteredUsersRequestDataAttributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestDataAttributesEventQuery": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestDataType": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + }, "QueryFormula": { "description": "A formula for calculation based on one or more queries.", "properties": { @@ -276355,6 +278264,164 @@ ], "type": "object" }, + "QueryResponse": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryResponseData": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryResponseDataAttributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "QueryResponseDataType": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + }, "QuerySortOrder": { "default": "desc", "description": "Direction of sort.", @@ -276368,6 +278435,201 @@ "DESC" ] }, + "QueryUsersRequest": { + "example": { + "data": { + "attributes": { + "limit": 25, + "query": "user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "user_name", + "user_org_id", + "first_country_code", + "first_browser_name", + "first_device_type", + "last_seen" + ], + "sort": { + "field": "first_seen", + "order": "DESC" + }, + "wildcard_search_term": "john" + }, + "id": "query_users_request", + "type": "query_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryUsersRequestData": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryUsersRequestDataAttributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "QueryUsersRequestDataAttributesSort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "QueryUsersRequestDataType": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + }, "RUMAggregateBucketValue": { "description": "A bucket value, can be either a timeseries or a single value.", "oneOf": [ @@ -377156,6 +379418,368 @@ }, "type": "object" }, + "UpdateConnectionRequest": { + "example": { + "data": { + "attributes": { + "fields_to_add": [ + { + "description": "Net Promoter Score from customer surveys", + "display_name": "NPS Score", + "groups": [ + "Satisfaction", + "Metrics" + ], + "id": "nps_score", + "source_name": "net_promoter_score", + "type": "number" + } + ], + "fields_to_delete": [ + "old_revenue_field" + ], + "fields_to_update": [ + { + "field_id": "lifetime_value", + "updated_display_name": "Customer Lifetime Value (`USD`)", + "updated_groups": [ + "Financial", + "Metrics" + ] + } + ] + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "", + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + }, + "UpdateConnectionRequestData": { + "properties": { + "attributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "", + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "UpdateConnectionRequestDataAttributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "UpdateConnectionRequestDataAttributesFieldsToUpdateItems": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "UpdateConnectionRequestDataType": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + }, "UpdateCustomFrameworkRequest": { "description": "Request object to update a custom framework.", "properties": { @@ -585190,88 +587814,2208 @@ "appKeyAuth": [] }, { - "AuthZ": [ - "dashboards_write" - ] + "AuthZ": [ + "dashboards_write" + ] + } + ], + "summary": "Update a powerpack", + "tags": [ + "Powerpack" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 5, + "x-permission": { + "operator": "OR", + "permissions": [ + "dashboards_write" + ] + } + } + }, + "/api/v2/processes": { + "get": { + "description": "Get all processes for your organization.", + "operationId": "ListProcesses", + "parameters": [ + { + "description": "String to search processes by.", + "in": "query", + "name": "search", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Comma-separated list of tags to filter processes by.", + "example": "account:prod,user:admin", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", + "in": "query", + "name": "from", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + }, + { + "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", + "in": "query", + "name": "to", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + }, + { + "description": "Maximum number of results returned.", + "in": "query", + "name": "page[limit]", + "required": false, + "schema": { + "default": 1000, + "format": "int32", + "maximum": 10000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.", + "in": "query", + "name": "page[cursor]", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List of process summaries.", + "properties": { + "data": { + "description": "Array of process summary objects.", + "items": { + "description": "Process summary object.", + "properties": { + "attributes": { + "description": "Attributes for a process summary.", + "properties": { + "cmdline": { + "description": "Process command line.", + "type": "string" + }, + "host": { + "description": "Host running the process.", + "type": "string" + }, + "pid": { + "description": "Process ID.", + "format": "int64", + "type": "integer" + }, + "ppid": { + "description": "Parent process ID.", + "format": "int64", + "type": "integer" + }, + "start": { + "description": "Time the process was started.", + "type": "string" + }, + "tags": { + "description": "List of tags associated with the process.", + "items": { + "description": "A tag associated with the process.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Time the process was seen.", + "type": "string" + }, + "user": { + "description": "Process owner.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Process ID.", + "type": "string" + }, + "type": { + "default": "process", + "description": "Type of process summary.", + "enum": [ + "process" + ], + "example": "process", + "type": "string", + "x-enum-varnames": [ + "PROCESS" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Response metadata object.", + "properties": { + "page": { + "description": "Paging attributes.", + "properties": { + "after": { + "description": "The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", + "example": "911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd", + "type": "string" + }, + "size": { + "description": "Number of results returned.", + "format": "int32", + "maximum": 10000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Authentication Error" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get all processes", + "tags": [ + "Processes" + ], + "x-menu-order": 1, + "x-pagination": { + "cursorParam": "page[cursor]", + "cursorPath": "meta.page.after", + "limitParam": "page[limit]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OPEN", + "permissions": [] + } + } + }, + "/api/v2/product-analytics/accounts/facet_info": { + "post": { + "description": "Get facet information for account attributes including possible values and counts", + "operationId": "GetAccountFacetInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "facet_id": "first_browser_name", + "limit": 10, + "search": { + "query": "user_org_id:5001 AND first_country_code:US" + }, + "term_search": { + "value": "Chrome" + } + }, + "id": "facet_info_request", + "type": "users_facet_info_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with facet information" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get account facet info", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 5, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/accounts/query": { + "post": { + "description": "Query accounts with flexible filtering by account properties", + "operationId": "QueryAccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "limit": 20, + "query": "plan_type:enterprise AND user_count:>100 AND subscription_status:active", + "select_columns": [ + "account_id", + "account_name", + "user_count", + "plan_type", + "subscription_status", + "created_at", + "mrr", + "industry" + ], + "sort": { + "field": "user_count", + "order": "DESC" + }, + "wildcard_search_term": "tech" + }, + "id": "query_account_request", + "type": "query_account_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with account data" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Query accounts", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 1, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/users/event_filtered_query": { + "post": { + "description": "Query users filtered by both user properties and event platform data", + "operationId": "QueryEventFilteredUsers", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "event_query": { + "query": "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform", + "time_frame": { + "end": 1761309676, + "start": 1760100076 + } + }, + "include_row_count": true, + "limit": 25, + "query": "user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "first_country_code", + "first_browser_name", + "events_count", + "session_count", + "error_count", + "avg_loading_time" + ] + }, + "id": "query_event_filtered_users_request", + "type": "query_event_filtered_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with filtered user data" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Query event filtered users", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 4, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/users/facet_info": { + "post": { + "description": "Get facet information for user attributes including possible values and counts", + "operationId": "GetUserFacetInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "facet_id": "first_browser_name", + "limit": 10, + "search": { + "query": "user_org_id:5001 AND first_country_code:US" + }, + "term_search": { + "value": "Chrome" + } + }, + "id": "facet_info_request", + "type": "users_facet_info_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with facet information" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get user facet info", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 9, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/users/query": { + "post": { + "description": "Query users with flexible filtering by user properties, with optional wildcard search", + "operationId": "QueryUsers", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "limit": 25, + "query": "user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "user_name", + "user_org_id", + "first_country_code", + "first_browser_name", + "first_device_type", + "last_seen" + ], + "sort": { + "field": "first_seen", + "order": "DESC" + }, + "wildcard_search_term": "john" + }, + "id": "query_users_request", + "type": "query_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with user data" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Query users", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 8, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/{entity}/mapping": { + "get": { + "description": "Get entity mapping configuration including all available attributes and their properties", + "operationId": "GetMapping", + "parameters": [ + { + "description": "The entity for which to get the mapping", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "attributes": [ + { + "attribute": "user_id", + "description": "Unique user identifier", + "display_name": "User ID", + "groups": [ + "Identity" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "user_email", + "description": "User email address", + "display_name": "Email Address", + "groups": [ + "Identity", + "Contact" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "first_country_code", + "description": "The ISO code of the country for the user's first session", + "display_name": "First Country Code", + "groups": [ + "Geography" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "@customer_tier", + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business" + ], + "is_custom": true, + "type": "string" + } + ] + }, + "id": "get_mappings_response", + "type": "get_mappings_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with entity mapping configuration" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get mapping", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 10, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/{entity}/mapping/connection": { + "post": { + "description": "Create a new data connection and its fields for an entity", + "operationId": "CreateConnection", + "parameters": [ + { + "description": "The entity for which to create the connection", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "fields": [ + { + "description": "Customer subscription tier from `CRM`", + "display_name": "Customer Tier", + "id": "customer_tier", + "source_name": "subscription_tier", + "type": "string" + }, + { + "description": "Customer lifetime value in `USD`", + "display_name": "Lifetime Value", + "id": "lifetime_value", + "source_name": "ltv", + "type": "number" + } + ], + "join_attribute": "user_email", + "join_type": "email", + "type": "ref_table" + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Connection created successfully" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Create connection", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 2, + "x-unstable": "**Note**: This endpoint may be subject to changes." + }, + "put": { + "description": "Update an existing data connection by adding, updating, or deleting fields", + "operationId": "UpdateConnection", + "parameters": [ + { + "description": "The entity for which to update the connection", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "fields_to_add": [ + { + "description": "Net Promoter Score from customer surveys", + "display_name": "NPS Score", + "groups": [ + "Satisfaction", + "Metrics" + ], + "id": "nps_score", + "source_name": "net_promoter_score", + "type": "number" + } + ], + "fields_to_delete": [ + "old_revenue_field" + ], + "fields_to_update": [ + { + "field_id": "lifetime_value", + "updated_display_name": "Customer Lifetime Value (`USD`)", + "updated_groups": [ + "Financial", + "Metrics" + ] + } + ] + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "", + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Connection updated successfully" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Update connection", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 3, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/{entity}/mapping/connection/{id}": { + "delete": { + "description": "Delete an existing data connection for an entity", + "operationId": "DeleteConnection", + "parameters": [ + { + "description": "The connection ID to delete", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "connection-id-123", + "type": "string" + } + }, + { + "description": "The entity for which to delete the connection", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Connection deleted successfully" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] } ], - "summary": "Update a powerpack", + "summary": "Delete connection", "tags": [ - "Powerpack" + "Rum Audience Management" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 5, - "x-permission": { - "operator": "OR", - "permissions": [ - "dashboards_write" - ] - } + "x-menu-order": 6, + "x-unstable": "**Note**: This endpoint may be subject to changes." } }, - "/api/v2/processes": { + "/api/v2/product-analytics/{entity}/mapping/connections": { "get": { - "description": "Get all processes for your organization.", - "operationId": "ListProcesses", + "description": "List all data connections for an entity", + "operationId": "ListConnections", "parameters": [ { - "description": "String to search processes by.", - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Comma-separated list of tags to filter processes by.", - "example": "account:prod,user:admin", - "in": "query", - "name": "tags", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", - "in": "query", - "name": "from", - "required": false, - "schema": { - "format": "int64", - "type": "integer" - } - }, - { - "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", - "in": "query", - "name": "to", - "required": false, - "schema": { - "format": "int64", - "type": "integer" - } - }, - { - "description": "Maximum number of results returned.", - "in": "query", - "name": "page[limit]", - "required": false, - "schema": { - "default": 1000, - "format": "int32", - "maximum": 10000, - "minimum": 1, - "type": "integer" - } - }, - { - "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.", - "in": "query", - "name": "page[cursor]", - "required": false, + "description": "The entity for which to list connections", + "in": "path", + "name": "entity", + "required": true, "schema": { + "example": "users", "type": "string" } } @@ -585281,164 +590025,169 @@ "content": { "application/json": { "schema": { - "description": "List of process summaries.", - "properties": { + "example": { "data": { - "description": "Array of process summary objects.", - "items": { - "description": "Process summary object.", - "properties": { - "attributes": { - "description": "Attributes for a process summary.", - "properties": { - "cmdline": { - "description": "Process command line.", - "type": "string" - }, - "host": { - "description": "Host running the process.", - "type": "string" - }, - "pid": { - "description": "Process ID.", - "format": "int64", - "type": "integer" - }, - "ppid": { - "description": "Parent process ID.", - "format": "int64", - "type": "integer" - }, - "start": { - "description": "Time the process was started.", - "type": "string" - }, - "tags": { - "description": "List of tags associated with the process.", - "items": { - "description": "A tag associated with the process.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "Time the process was seen.", + "attributes": { + "connections": [ + { + "created_at": "0001-01-01T00:00:00Z", + "created_by": "00000000-0000-0000-0000-000000000000", + "fields": [ + { + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business", + "Subscription" + ], + "id": "customer_tier", + "source_name": "subscription_tier", "type": "string" }, - "user": { - "description": "Process owner.", + { + "description": "Channel through which user signed up", + "display_name": "Signup Source", + "groups": [ + "Marketing", + "Attribution" + ], + "id": "signup_source", + "source_name": "acquisition_channel", "type": "string" } - }, - "type": "object" - }, - "id": { - "description": "Process ID.", - "type": "string" - }, - "type": { - "default": "process", - "description": "Type of process summary.", - "enum": [ - "process" ], - "example": "process", - "type": "string", - "x-enum-varnames": [ - "PROCESS" - ] + "id": "user-profiles-connection", + "join": { + "attribute": "user_email", + "type": "email" + }, + "type": "ref_table", + "updated_at": "0001-01-01T00:00:00Z", + "updated_by": "00000000-0000-0000-0000-000000000000" } - }, - "type": "object" + ] }, - "type": "array" - }, - "meta": { - "description": "Response metadata object.", + "id": "list_connections_response", + "type": "list_connections_response" + } + }, + "properties": { + "data": { "properties": { - "page": { - "description": "Paging attributes.", + "attributes": { "properties": { - "after": { - "description": "The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", - "example": "911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd", - "type": "string" - }, - "size": { - "description": "Number of results returned.", - "format": "int32", - "maximum": 10000, - "minimum": 0, - "type": "integer" + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] } }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - }, - "400": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request" - }, - "403": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" + "required": [ + "type" ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" + "type": "object" } }, - "required": [ - "errors" - ], "type": "object" } } }, - "description": "Authentication Error" + "description": "Successful response with list of connections" }, "429": { "content": { @@ -585478,21 +590227,12 @@ "AuthZ": [] } ], - "summary": "Get all processes", + "summary": "List connections", "tags": [ - "Processes" + "Rum Audience Management" ], - "x-menu-order": 1, - "x-pagination": { - "cursorParam": "page[cursor]", - "cursorPath": "meta.page.after", - "limitParam": "page[limit]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OPEN", - "permissions": [] - } + "x-menu-order": 7, + "x-unstable": "**Note**: This endpoint may be subject to changes." } }, "/api/v2/query/scalar": { @@ -738104,6 +742844,10 @@ "description": "The Roles API is used to create and manage Datadog roles, what\n[global permissions](https://docs.datadoghq.com/account_management/rbac/)\nthey grant, and which users belong to them.\n\nPermissions related to specific account assets can be granted to roles\nin the Datadog application without using this API. For example, granting\nread access on a specific log index to a role can be done in Datadog from the\n[Pipelines page](https://app.datadoghq.com/logs/pipelines).", "name": "Roles" }, + { + "description": "Auto-generated tag Rum Audience Management", + "name": "Rum Audience Management" + }, { "description": "Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) for your organization.", "externalDocs": { diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 906936d3c64fb..5bda4dc893ad4 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1992,6 +1992,60 @@ "description": "Get all processes for your organization.", "summary": "Get all processes" }, + "GetAccountFacetInfo": { + "description": "Get facet information for account attributes including possible values and counts", + "summary": "Get account facet info", + "request_description": "", + "request_schema_description": "" + }, + "QueryAccounts": { + "description": "Query accounts with flexible filtering by account properties", + "summary": "Query accounts", + "request_description": "", + "request_schema_description": "" + }, + "QueryEventFilteredUsers": { + "description": "Query users filtered by both user properties and event platform data", + "summary": "Query event filtered users", + "request_description": "", + "request_schema_description": "" + }, + "GetUserFacetInfo": { + "description": "Get facet information for user attributes including possible values and counts", + "summary": "Get user facet info", + "request_description": "", + "request_schema_description": "" + }, + "QueryUsers": { + "description": "Query users with flexible filtering by user properties, with optional wildcard search", + "summary": "Query users", + "request_description": "", + "request_schema_description": "" + }, + "GetMapping": { + "description": "Get entity mapping configuration including all available attributes and their properties", + "summary": "Get mapping" + }, + "CreateConnection": { + "description": "Create a new data connection and its fields for an entity", + "summary": "Create connection", + "request_description": "", + "request_schema_description": "" + }, + "UpdateConnection": { + "description": "Update an existing data connection by adding, updating, or deleting fields", + "summary": "Update connection", + "request_description": "", + "request_schema_description": "" + }, + "DeleteConnection": { + "description": "Delete an existing data connection for an entity", + "summary": "Delete connection" + }, + "ListConnections": { + "description": "List all data connections for an entity", + "summary": "List connections" + }, "QueryScalarData": { "description": "Query scalar values (as seen on Query Value, Table, and Toplist widgets).\nMultiple data sources are supported with the ability to\nprocess the data using formulas and functions.", "summary": "Query scalar data across multiple products", diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 458ba446ed527..2267ca6002270 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -247,6 +247,10 @@ "name": "Roles", "description": "The Roles API is used to create and manage Datadog roles, what\n[global permissions](https://docs.datadoghq.com/account_management/rbac/)\nthey grant, and which users belong to them.\n\nPermissions related to specific account assets can be granted to roles\nin the Datadog application without using this API. For example, granting\nread access on a specific log index to a role can be done in Datadog from the\n[Pipelines page](https://app.datadoghq.com/logs/pipelines)." }, + "rum-audience-management": { + "name": "Rum Audience Management", + "description": "Auto-generated tag Rum Audience Management" + }, "rum-metrics": { "name": "Rum Metrics", "description": "Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) for your organization." diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 734568224aea8..0f104cd1ef7d9 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -79938,6 +79938,313 @@ ], "type": "object" }, + "CreateConnectionRequest": { + "example": { + "data": { + "attributes": { + "fields": [ + { + "description": "Customer subscription tier from `CRM`", + "display_name": "Customer Tier", + "id": "customer_tier", + "source_name": "subscription_tier", + "type": "string" + }, + { + "description": "Customer lifetime value in `USD`", + "display_name": "Lifetime Value", + "id": "lifetime_value", + "source_name": "ltv", + "type": "number" + } + ], + "join_attribute": "user_email", + "join_type": "email", + "type": "ref_table" + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "CreateConnectionRequestData": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "CreateConnectionRequestDataAttributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "CreateConnectionRequestDataAttributesFieldsItems": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, "CreateCustomFrameworkRequest": { "description": "Request object to create a custom framework.", "properties": { @@ -121939,6 +122246,460 @@ "REPLACE" ] }, + "FacetInfoRequest": { + "example": { + "data": { + "attributes": { + "facet_id": "first_browser_name", + "limit": 10, + "search": { + "query": "user_org_id:5001 AND first_country_code:US" + }, + "term_search": { + "value": "Chrome" + } + }, + "id": "facet_info_request", + "type": "users_facet_info_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoRequestData": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "FacetInfoRequestDataAttributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "FacetInfoRequestDataAttributesSearch": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "FacetInfoRequestDataAttributesTermSearch": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + }, + "FacetInfoRequestDataType": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + }, + "FacetInfoResponse": { + "example": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoResponseData": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "FacetInfoResponseDataAttributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoResponseDataAttributesResult": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "FacetInfoResponseDataAttributesResultRange": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "FacetInfoResponseDataAttributesResultValuesItems": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "FacetInfoResponseDataType": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + }, "FastlyAPIKey": { "description": "The definition of the `FastlyAPIKey` object.", "properties": { @@ -134745,6 +135506,248 @@ "TEAM_OWNERS" ] }, + "GetMappingResponse": { + "example": { + "data": { + "attributes": { + "attributes": [ + { + "attribute": "user_id", + "description": "Unique user identifier", + "display_name": "User ID", + "groups": [ + "Identity" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "user_email", + "description": "User email address", + "display_name": "Email Address", + "groups": [ + "Identity", + "Contact" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "first_country_code", + "description": "The ISO code of the country for the user's first session", + "display_name": "First Country Code", + "groups": [ + "Geography" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "@customer_tier", + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business" + ], + "is_custom": true, + "type": "string" + } + ] + }, + "id": "get_mappings_response", + "type": "get_mappings_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "GetMappingResponseData": { + "properties": { + "attributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMappingResponseDataAttributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetMappingResponseDataAttributesAttributesItems": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "GetMappingResponseDataType": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + }, "GetMultipleRulesetsRequest": { "properties": { "data": { @@ -185414,6 +186417,466 @@ ], "type": "object" }, + "ListConnectionsResponse": { + "example": { + "data": { + "attributes": { + "connections": [ + { + "created_at": "0001-01-01T00:00:00Z", + "created_by": "00000000-0000-0000-0000-000000000000", + "fields": [ + { + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business", + "Subscription" + ], + "id": "customer_tier", + "source_name": "subscription_tier", + "type": "string" + }, + { + "description": "Channel through which user signed up", + "display_name": "Signup Source", + "groups": [ + "Marketing", + "Attribution" + ], + "id": "signup_source", + "source_name": "acquisition_channel", + "type": "string" + } + ], + "id": "user-profiles-connection", + "join": { + "attribute": "user_email", + "type": "email" + }, + "type": "ref_table", + "updated_at": "0001-01-01T00:00:00Z", + "updated_by": "00000000-0000-0000-0000-000000000000" + } + ] + }, + "id": "list_connections_response", + "type": "list_connections_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "ListConnectionsResponseData": { + "properties": { + "attributes": { + "properties": { + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "ListConnectionsResponseDataAttributes": { + "properties": { + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListConnectionsResponseDataAttributesConnectionsItems": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "ListConnectionsResponseDataAttributesConnectionsItemsJoin": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ListConnectionsResponseDataType": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] + }, "ListDevicesResponse": { "description": "List devices response.", "properties": { @@ -276315,6 +277778,452 @@ } ] }, + "QueryAccountRequest": { + "example": { + "data": { + "attributes": { + "limit": 20, + "query": "plan_type:enterprise AND user_count:>100 AND subscription_status:active", + "select_columns": [ + "account_id", + "account_name", + "user_count", + "plan_type", + "subscription_status", + "created_at", + "mrr", + "industry" + ], + "sort": { + "field": "user_count", + "order": "DESC" + }, + "wildcard_search_term": "tech" + }, + "id": "query_account_request", + "type": "query_account_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryAccountRequestData": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryAccountRequestDataAttributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "QueryAccountRequestDataAttributesSort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "QueryAccountRequestDataType": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + }, + "QueryEventFilteredUsersRequest": { + "example": { + "data": { + "attributes": { + "event_query": { + "query": "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform", + "time_frame": { + "end": 1761309676, + "start": 1760100076 + } + }, + "include_row_count": true, + "limit": 25, + "query": "user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "first_country_code", + "first_browser_name", + "events_count", + "session_count", + "error_count", + "avg_loading_time" + ] + }, + "id": "query_event_filtered_users_request", + "type": "query_event_filtered_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestData": { + "properties": { + "attributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryEventFilteredUsersRequestDataAttributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestDataAttributesEventQuery": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "QueryEventFilteredUsersRequestDataType": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + }, "QueryFormula": { "description": "A formula for calculation based on one or more queries.", "properties": { @@ -276355,6 +278264,164 @@ ], "type": "object" }, + "QueryResponse": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryResponseData": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryResponseDataAttributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "QueryResponseDataType": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + }, "QuerySortOrder": { "default": "desc", "description": "Direction of sort.", @@ -276368,6 +278435,201 @@ "DESC" ] }, + "QueryUsersRequest": { + "example": { + "data": { + "attributes": { + "limit": 25, + "query": "user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "user_name", + "user_org_id", + "first_country_code", + "first_browser_name", + "first_device_type", + "last_seen" + ], + "sort": { + "field": "first_seen", + "order": "DESC" + }, + "wildcard_search_term": "john" + }, + "id": "query_users_request", + "type": "query_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "QueryUsersRequestData": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "QueryUsersRequestDataAttributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "QueryUsersRequestDataAttributesSort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "QueryUsersRequestDataType": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + }, "RUMAggregateBucketValue": { "description": "A bucket value, can be either a timeseries or a single value.", "oneOf": [ @@ -377156,6 +379418,368 @@ }, "type": "object" }, + "UpdateConnectionRequest": { + "example": { + "data": { + "attributes": { + "fields_to_add": [ + { + "description": "Net Promoter Score from customer surveys", + "display_name": "NPS Score", + "groups": [ + "Satisfaction", + "Metrics" + ], + "id": "nps_score", + "source_name": "net_promoter_score", + "type": "number" + } + ], + "fields_to_delete": [ + "old_revenue_field" + ], + "fields_to_update": [ + { + "field_id": "lifetime_value", + "updated_display_name": "Customer Lifetime Value (`USD`)", + "updated_groups": [ + "Financial", + "Metrics" + ] + } + ] + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "", + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + }, + "UpdateConnectionRequestData": { + "properties": { + "attributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "", + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "UpdateConnectionRequestDataAttributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "UpdateConnectionRequestDataAttributesFieldsToUpdateItems": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "UpdateConnectionRequestDataType": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + }, "UpdateCustomFrameworkRequest": { "description": "Request object to update a custom framework.", "properties": { @@ -585190,88 +587814,2208 @@ "appKeyAuth": [] }, { - "AuthZ": [ - "dashboards_write" - ] + "AuthZ": [ + "dashboards_write" + ] + } + ], + "summary": "Update a powerpack", + "tags": [ + "Powerpack" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 5, + "x-permission": { + "operator": "OR", + "permissions": [ + "dashboards_write" + ] + } + } + }, + "/api/v2/processes": { + "get": { + "description": "Get all processes for your organization.", + "operationId": "ListProcesses", + "parameters": [ + { + "description": "String to search processes by.", + "in": "query", + "name": "search", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Comma-separated list of tags to filter processes by.", + "example": "account:prod,user:admin", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", + "in": "query", + "name": "from", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + }, + { + "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", + "in": "query", + "name": "to", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + }, + { + "description": "Maximum number of results returned.", + "in": "query", + "name": "page[limit]", + "required": false, + "schema": { + "default": 1000, + "format": "int32", + "maximum": 10000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.", + "in": "query", + "name": "page[cursor]", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List of process summaries.", + "properties": { + "data": { + "description": "Array of process summary objects.", + "items": { + "description": "Process summary object.", + "properties": { + "attributes": { + "description": "Attributes for a process summary.", + "properties": { + "cmdline": { + "description": "Process command line.", + "type": "string" + }, + "host": { + "description": "Host running the process.", + "type": "string" + }, + "pid": { + "description": "Process ID.", + "format": "int64", + "type": "integer" + }, + "ppid": { + "description": "Parent process ID.", + "format": "int64", + "type": "integer" + }, + "start": { + "description": "Time the process was started.", + "type": "string" + }, + "tags": { + "description": "List of tags associated with the process.", + "items": { + "description": "A tag associated with the process.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Time the process was seen.", + "type": "string" + }, + "user": { + "description": "Process owner.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Process ID.", + "type": "string" + }, + "type": { + "default": "process", + "description": "Type of process summary.", + "enum": [ + "process" + ], + "example": "process", + "type": "string", + "x-enum-varnames": [ + "PROCESS" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Response metadata object.", + "properties": { + "page": { + "description": "Paging attributes.", + "properties": { + "after": { + "description": "The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", + "example": "911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd", + "type": "string" + }, + "size": { + "description": "Number of results returned.", + "format": "int32", + "maximum": 10000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Authentication Error" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get all processes", + "tags": [ + "Processes" + ], + "x-menu-order": 1, + "x-pagination": { + "cursorParam": "page[cursor]", + "cursorPath": "meta.page.after", + "limitParam": "page[limit]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OPEN", + "permissions": [] + } + } + }, + "/api/v2/product-analytics/accounts/facet_info": { + "post": { + "description": "Get facet information for account attributes including possible values and counts", + "operationId": "GetAccountFacetInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "facet_id": "first_browser_name", + "limit": 10, + "search": { + "query": "user_org_id:5001 AND first_country_code:US" + }, + "term_search": { + "value": "Chrome" + } + }, + "id": "facet_info_request", + "type": "users_facet_info_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with facet information" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get account facet info", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 5, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/accounts/query": { + "post": { + "description": "Query accounts with flexible filtering by account properties", + "operationId": "QueryAccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "limit": 20, + "query": "plan_type:enterprise AND user_count:>100 AND subscription_status:active", + "select_columns": [ + "account_id", + "account_name", + "user_count", + "plan_type", + "subscription_status", + "created_at", + "mrr", + "industry" + ], + "sort": { + "field": "user_count", + "order": "DESC" + }, + "wildcard_search_term": "tech" + }, + "id": "query_account_request", + "type": "query_account_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_account_request", + "description": "Query account request resource type.", + "enum": [ + "query_account_request" + ], + "example": "query_account_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_ACCOUNT_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with account data" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Query accounts", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 1, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/users/event_filtered_query": { + "post": { + "description": "Query users filtered by both user properties and event platform data", + "operationId": "QueryEventFilteredUsers", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "event_query": { + "query": "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform", + "time_frame": { + "end": 1761309676, + "start": 1760100076 + } + }, + "include_row_count": true, + "limit": 25, + "query": "user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "first_country_code", + "first_browser_name", + "events_count", + "session_count", + "error_count", + "avg_loading_time" + ] + }, + "id": "query_event_filtered_users_request", + "type": "query_event_filtered_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "event_query": { + "properties": { + "query": { + "type": "string" + }, + "time_frame": { + "properties": { + "end": { + "format": "int64", + "type": "integer" + }, + "start": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "include_row_count": { + "type": "boolean" + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_event_filtered_users_request", + "description": "Query event filtered users request resource type.", + "enum": [ + "query_event_filtered_users_request" + ], + "example": "query_event_filtered_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_EVENT_FILTERED_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with filtered user data" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Query event filtered users", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 4, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/users/facet_info": { + "post": { + "description": "Get facet information for user attributes including possible values and counts", + "operationId": "GetUserFacetInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "facet_id": "first_browser_name", + "limit": 10, + "search": { + "query": "user_org_id:5001 AND first_country_code:US" + }, + "term_search": { + "value": "Chrome" + } + }, + "id": "facet_info_request", + "type": "users_facet_info_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "facet_id": { + "example": "", + "type": "string" + }, + "limit": { + "example": 0, + "format": "int64", + "type": "integer" + }, + "search": { + "properties": { + "query": { + "type": "string" + } + }, + "type": "object" + }, + "term_search": { + "properties": { + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "facet_id", + "limit" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info_request", + "description": "Users facet info request resource type.", + "enum": [ + "users_facet_info_request" + ], + "example": "users_facet_info_request", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "result": { + "values": [ + { + "count": 4892, + "value": "Chrome" + }, + { + "count": 2341, + "value": "Safari" + }, + { + "count": 1567, + "value": "Firefox" + }, + { + "count": 892, + "value": "Edge" + }, + { + "count": 234, + "value": "Opera" + } + ] + } + }, + "id": "facet_info_response", + "type": "users_facet_info" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "result": { + "properties": { + "range": { + "properties": { + "max": { + "type": "object" + }, + "min": { + "type": "object" + } + }, + "type": "object" + }, + "values": { + "items": { + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "users_facet_info", + "description": "Users facet info resource type.", + "enum": [ + "users_facet_info" + ], + "example": "users_facet_info", + "type": "string", + "x-enum-varnames": [ + "USERS_FACET_INFO" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with facet information" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get user facet info", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 9, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/users/query": { + "post": { + "description": "Query users with flexible filtering by user properties, with optional wildcard search", + "operationId": "QueryUsers", + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "limit": 25, + "query": "user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome", + "select_columns": [ + "user_id", + "user_email", + "user_name", + "user_org_id", + "first_country_code", + "first_browser_name", + "first_device_type", + "last_seen" + ], + "sort": { + "field": "first_seen", + "order": "DESC" + }, + "wildcard_search_term": "john" + }, + "id": "query_users_request", + "type": "query_users_request" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + }, + "select_columns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sort": { + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + }, + "type": "object" + }, + "wildcard_search_term": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_users_request", + "description": "Query users request resource type.", + "enum": [ + "query_users_request" + ], + "example": "query_users_request", + "type": "string", + "x-enum-varnames": [ + "QUERY_USERS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "hits": [ + { + "first_browser_name": "Chrome", + "first_city": "San Francisco", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T06:45:12.142Z", + "session_count": 47, + "user_created": "2024-12-15T08:42:33.287Z", + "user_email": "john.smith@techcorp.com", + "user_id": "150847", + "user_name": "John Smith", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Austin", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T05:22:08.951Z", + "session_count": 89, + "user_created": "2024-11-28T14:17:45.634Z", + "user_email": "john.williams@techcorp.com", + "user_id": "150848", + "user_name": "John Williams", + "user_org_id": "5001" + }, + { + "first_browser_name": "Chrome", + "first_city": "Seattle", + "first_country_code": "US", + "first_device_type": "Desktop", + "last_seen": "2025-08-14T04:18:34.726Z", + "session_count": 23, + "user_created": "2025-01-03T16:33:21.445Z", + "user_email": "john.jones@techcorp.com", + "user_id": "150849", + "user_name": "John Jones", + "user_org_id": "5001" + } + ], + "total": 147 + }, + "id": "query_response", + "type": "query_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "hits": { + "items": { + "additionalProperties": {} + }, + "type": "array" + }, + "total": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "query_response", + "description": "Query response resource type.", + "enum": [ + "query_response" + ], + "example": "query_response", + "type": "string", + "x-enum-varnames": [ + "QUERY_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with user data" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Query users", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 8, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/{entity}/mapping": { + "get": { + "description": "Get entity mapping configuration including all available attributes and their properties", + "operationId": "GetMapping", + "parameters": [ + { + "description": "The entity for which to get the mapping", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "attributes": [ + { + "attribute": "user_id", + "description": "Unique user identifier", + "display_name": "User ID", + "groups": [ + "Identity" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "user_email", + "description": "User email address", + "display_name": "Email Address", + "groups": [ + "Identity", + "Contact" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "first_country_code", + "description": "The ISO code of the country for the user's first session", + "display_name": "First Country Code", + "groups": [ + "Geography" + ], + "is_custom": false, + "type": "string" + }, + { + "attribute": "@customer_tier", + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business" + ], + "is_custom": true, + "type": "string" + } + ] + }, + "id": "get_mappings_response", + "type": "get_mappings_response" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "attributes": { + "items": { + "properties": { + "attribute": { + "type": "string" + }, + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "is_custom": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "get_mappings_response", + "description": "Get mappings response resource type.", + "enum": [ + "get_mappings_response" + ], + "example": "get_mappings_response", + "type": "string", + "x-enum-varnames": [ + "GET_MAPPINGS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successful response with entity mapping configuration" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Get mapping", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 10, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/{entity}/mapping/connection": { + "post": { + "description": "Create a new data connection and its fields for an entity", + "operationId": "CreateConnection", + "parameters": [ + { + "description": "The entity for which to create the connection", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "fields": [ + { + "description": "Customer subscription tier from `CRM`", + "display_name": "Customer Tier", + "id": "customer_tier", + "source_name": "subscription_tier", + "type": "string" + }, + { + "description": "Customer lifetime value in `USD`", + "display_name": "Lifetime Value", + "id": "lifetime_value", + "source_name": "ltv", + "type": "number" + } + ], + "join_attribute": "user_email", + "join_type": "email", + "type": "ref_table" + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "join_attribute": { + "example": "", + "type": "string" + }, + "join_type": { + "example": "", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "join_attribute", + "join_type", + "type" + ], + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Connection created successfully" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Create connection", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 2, + "x-unstable": "**Note**: This endpoint may be subject to changes." + }, + "put": { + "description": "Update an existing data connection by adding, updating, or deleting fields", + "operationId": "UpdateConnection", + "parameters": [ + { + "description": "The entity for which to update the connection", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "attributes": { + "fields_to_add": [ + { + "description": "Net Promoter Score from customer surveys", + "display_name": "NPS Score", + "groups": [ + "Satisfaction", + "Metrics" + ], + "id": "nps_score", + "source_name": "net_promoter_score", + "type": "number" + } + ], + "fields_to_delete": [ + "old_revenue_field" + ], + "fields_to_update": [ + { + "field_id": "lifetime_value", + "updated_display_name": "Customer Lifetime Value (`USD`)", + "updated_groups": [ + "Financial", + "Metrics" + ] + } + ] + }, + "id": "crm-integration", + "type": "connection_id" + } + }, + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields_to_add": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "fields_to_delete": { + "items": { + "type": "string" + }, + "type": "array" + }, + "fields_to_update": { + "items": { + "properties": { + "field_id": { + "example": "", + "type": "string" + }, + "updated_description": { + "type": "string" + }, + "updated_display_name": { + "type": "string" + }, + "updated_field_id": { + "type": "string" + }, + "updated_groups": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "field_id" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "", + "type": "string" + }, + "type": { + "default": "connection_id", + "description": "Connection id resource type.", + "enum": [ + "connection_id" + ], + "example": "connection_id", + "type": "string", + "x-enum-varnames": [ + "CONNECTION_ID" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Connection updated successfully" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Update connection", + "tags": [ + "Rum Audience Management" + ], + "x-menu-order": 3, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/product-analytics/{entity}/mapping/connection/{id}": { + "delete": { + "description": "Delete an existing data connection for an entity", + "operationId": "DeleteConnection", + "parameters": [ + { + "description": "The connection ID to delete", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "connection-id-123", + "type": "string" + } + }, + { + "description": "The entity for which to delete the connection", + "in": "path", + "name": "entity", + "required": true, + "schema": { + "example": "users", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Connection deleted successfully" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] } ], - "summary": "Update a powerpack", + "summary": "Delete connection", "tags": [ - "Powerpack" + "Rum Audience Management" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 5, - "x-permission": { - "operator": "OR", - "permissions": [ - "dashboards_write" - ] - } + "x-menu-order": 6, + "x-unstable": "**Note**: This endpoint may be subject to changes." } }, - "/api/v2/processes": { + "/api/v2/product-analytics/{entity}/mapping/connections": { "get": { - "description": "Get all processes for your organization.", - "operationId": "ListProcesses", + "description": "List all data connections for an entity", + "operationId": "ListConnections", "parameters": [ { - "description": "String to search processes by.", - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Comma-separated list of tags to filter processes by.", - "example": "account:prod,user:admin", - "in": "query", - "name": "tags", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", - "in": "query", - "name": "from", - "required": false, - "schema": { - "format": "int64", - "type": "integer" - } - }, - { - "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`.", - "in": "query", - "name": "to", - "required": false, - "schema": { - "format": "int64", - "type": "integer" - } - }, - { - "description": "Maximum number of results returned.", - "in": "query", - "name": "page[limit]", - "required": false, - "schema": { - "default": 1000, - "format": "int32", - "maximum": 10000, - "minimum": 1, - "type": "integer" - } - }, - { - "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`.", - "in": "query", - "name": "page[cursor]", - "required": false, + "description": "The entity for which to list connections", + "in": "path", + "name": "entity", + "required": true, "schema": { + "example": "users", "type": "string" } } @@ -585281,164 +590025,169 @@ "content": { "application/json": { "schema": { - "description": "List of process summaries.", - "properties": { + "example": { "data": { - "description": "Array of process summary objects.", - "items": { - "description": "Process summary object.", - "properties": { - "attributes": { - "description": "Attributes for a process summary.", - "properties": { - "cmdline": { - "description": "Process command line.", - "type": "string" - }, - "host": { - "description": "Host running the process.", - "type": "string" - }, - "pid": { - "description": "Process ID.", - "format": "int64", - "type": "integer" - }, - "ppid": { - "description": "Parent process ID.", - "format": "int64", - "type": "integer" - }, - "start": { - "description": "Time the process was started.", - "type": "string" - }, - "tags": { - "description": "List of tags associated with the process.", - "items": { - "description": "A tag associated with the process.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "Time the process was seen.", + "attributes": { + "connections": [ + { + "created_at": "0001-01-01T00:00:00Z", + "created_by": "00000000-0000-0000-0000-000000000000", + "fields": [ + { + "description": "Customer subscription tier", + "display_name": "Customer Tier", + "groups": [ + "Business", + "Subscription" + ], + "id": "customer_tier", + "source_name": "subscription_tier", "type": "string" }, - "user": { - "description": "Process owner.", + { + "description": "Channel through which user signed up", + "display_name": "Signup Source", + "groups": [ + "Marketing", + "Attribution" + ], + "id": "signup_source", + "source_name": "acquisition_channel", "type": "string" } - }, - "type": "object" - }, - "id": { - "description": "Process ID.", - "type": "string" - }, - "type": { - "default": "process", - "description": "Type of process summary.", - "enum": [ - "process" ], - "example": "process", - "type": "string", - "x-enum-varnames": [ - "PROCESS" - ] + "id": "user-profiles-connection", + "join": { + "attribute": "user_email", + "type": "email" + }, + "type": "ref_table", + "updated_at": "0001-01-01T00:00:00Z", + "updated_by": "00000000-0000-0000-0000-000000000000" } - }, - "type": "object" + ] }, - "type": "array" - }, - "meta": { - "description": "Response metadata object.", + "id": "list_connections_response", + "type": "list_connections_response" + } + }, + "properties": { + "data": { "properties": { - "page": { - "description": "Paging attributes.", + "attributes": { "properties": { - "after": { - "description": "The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", - "example": "911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd", - "type": "string" - }, - "size": { - "description": "Number of results returned.", - "format": "int32", - "maximum": 10000, - "minimum": 0, - "type": "integer" + "connections": { + "items": { + "properties": { + "created_at": { + "format": "date-time", + "type": "string" + }, + "created_by": { + "type": "string" + }, + "fields": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "", + "type": "string" + }, + "source_name": { + "example": "", + "type": "string" + }, + "type": { + "example": "", + "type": "string" + } + }, + "required": [ + "id", + "source_name", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "join": { + "properties": { + "attribute": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + }, + "updated_by": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "default": "list_connections_response", + "description": "List connections response resource type.", + "enum": [ + "list_connections_response" + ], + "example": "list_connections_response", + "type": "string", + "x-enum-varnames": [ + "LIST_CONNECTIONS_RESPONSE" + ] } }, - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "OK" - }, - "400": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request" - }, - "403": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" + "required": [ + "type" ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" + "type": "object" } }, - "required": [ - "errors" - ], "type": "object" } } }, - "description": "Authentication Error" + "description": "Successful response with list of connections" }, "429": { "content": { @@ -585478,21 +590227,12 @@ "AuthZ": [] } ], - "summary": "Get all processes", + "summary": "List connections", "tags": [ - "Processes" + "Rum Audience Management" ], - "x-menu-order": 1, - "x-pagination": { - "cursorParam": "page[cursor]", - "cursorPath": "meta.page.after", - "limitParam": "page[limit]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OPEN", - "permissions": [] - } + "x-menu-order": 7, + "x-unstable": "**Note**: This endpoint may be subject to changes." } }, "/api/v2/query/scalar": { @@ -738104,6 +742844,10 @@ "description": "The Roles API is used to create and manage Datadog roles, what\n[global permissions](https://docs.datadoghq.com/account_management/rbac/)\nthey grant, and which users belong to them.\n\nPermissions related to specific account assets can be granted to roles\nin the Datadog application without using this API. For example, granting\nread access on a specific log index to a role can be done in Datadog from the\n[Pipelines page](https://app.datadoghq.com/logs/pipelines).", "name": "Roles" }, + { + "description": "Auto-generated tag Rum Audience Management", + "name": "Rum Audience Management" + }, { "description": "Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) for your organization.", "externalDocs": {