| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of ad-source to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
{- "data": {
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "__typename": "Ad Source",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7",
- "name": "ad source",
- "ad_set_id": "65f1279c-87cb-4b80-9034-608af2eb45a8",
- "eid": 123123123,
- "created_at": "2023-03-29T00:00:00.000Z"
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of ad-source to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| channel_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: channel_id=123e4567-e89b-12d3-a456-426655440000 The channel id of source to delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of source to get or delete |
| channel_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: channel_id=123e4567-e89b-12d3-a456-426655440000 The channel_id of source to get or delete |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 Skip number of objects to get in list |
{- "limit": 10,
- "offset": 0,
- "total_count": 20,
- "data": [
- {
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "__typename": "Ad Source",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7",
- "name": "ad source",
- "ad_set_id": "65f1279c-87cb-4b80-9034-608af2eb45a8",
- "eid": 123123123,
- "created_at": "2023-03-29T00:00:00.000Z"
}, - {
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a7",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "__typename": "Ad Source",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7",
- "name": "ad source",
- "ad_set_id": "65f1279c-87cb-4b80-9034-608af2eb45a8",
- "eid": 123123123,
- "created_at": "2023-03-29T00:00:00.000Z"
}
]
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of source to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
{- "data": {
- "created_at": "2023-03-29T00:00:00.000Z",
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "__typename": "UTM Source",
- "utm_source": "source_utm",
- "utm_medium": "medium_utm",
- "utm_campaign": "campaign_utm",
- "utm_content": "content_utm",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7"
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of source to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| channel_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: channel_id=123e4567-e89b-12d3-a456-426655440000 Category ID |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of source to get or delete |
| channel_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: channel_id=123e4567-e89b-12d3-a456-426655440000 The channel_id of source to get or delete |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
{- "limit": 10,
- "offset": 0,
- "total_count": 20,
- "data": [
- {
- "created_at": "2023-03-29T00:00:00.000Z",
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "__typename": "UTM Source",
- "utm_source": "source_utm",
- "utm_medium": "medium_utm",
- "utm_campaign": "campaign_utm",
- "utm_content": "content_utm",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7"
}, - {
- "created_at": "2023-03-29T00:00:00.000Z",
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a7",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "__typename": "UTM Source",
- "utm_source": "source_utm",
- "utm_medium": "medium_utm",
- "utm_campaign": "campaign_utm",
- "utm_content": "content_utm",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7"
}, - {
- "created_at": "2023-03-29T00:00:00.000Z",
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a8",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "__typename": "UTM Source",
- "utm_source": "source_utm",
- "utm_medium": "medium_utm",
- "utm_campaign": "campaign_utm",
- "utm_content": "content_utm",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| name required | string |
| channel_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... |
{- "name": "John",
- "channel_id": "123e4567-e89b-12d3-a456-426655440000"
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of source to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
{- "data": {
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a4",
- "channel_id": "65f1279c-87cb-4b80-9034-608af2eb45a5",
- "type": "UTM Source",
- "name": "facebook",
- "source_id": "65f1279c-87cb-4b80-9034-608af2eb45a7"
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of source to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of source to get or delete |
| channel_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: channel_id=123e4567-e89b-12d3-a456-426655440000 The channel_id of source to get or delete |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
{- "limit": 10,
- "offset": 0,
- "total_count": 20,
- "data": [
- {
- "id": "1b9d6bcd-bbfd-4b1d-9b05-ab8dfbbd4be1",
- "workspace_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "channel_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "name": "My Source",
- "source_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "type": "Simple Source",
- "created_at": "2023-05-09T12:41:17.378Z"
}, - {
- "id": "1b9d6bcd-bbfd-4b1d-9b05-ab8dfbbd4be2",
- "workspace_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "channel_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "name": "My Source 2",
- "source_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "type": "Simple Source",
- "created_at": "2023-05-09T12:41:17.378Z"
}, - {
- "id": "1b9d6bcd-bbfd-4b1d-9b05-ab8dfbbd4be3",
- "workspace_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "channel_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "name": "My Source 3",
- "source_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "type": "Simple Source",
- "created_at": "2023-05-09T12:41:17.378Z"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| name required | string |
| icon required | string |
| ad_platform required | string |
| ad_account_id required | string |
{- "name": "John doe",
- "icon": "example@hello.com",
- "ad_platform": "v71271h812",
- "ad_account_id": 636367618627
}{- "data": {
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "ad_account_id": 3123132131321,
- "ad_platform": "86a11c49-2800",
- "name": "Link1",
- "icon": "url.com"
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of channel to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
{- "data": {
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "ad_account_id": 3123132131321,
- "ad_platform": "86a11c49-2800-4b6d-a0ad-ad46653ec464",
- "name": "Links",
- "icon": "url"
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of channel to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of channel to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| name | string |
| icon | string |
{- "name": "John doe",
- "icon": "left-message"
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| name required | string |
| icon required | string |
required | Array of objects (UtmCondition) |
{- "name": "John doe",
- "icon": "left-message",
- "conditions": [
- {
- "utm_source": "utm_source",
- "utm_medium": "utm_medium",
- "utm_campaign": "utm_campaign",
- "utm_content": "utm_content"
}
]
}{- "data": {
- "id": "0db57de4-3ca3-45bd-af38-f6cf63d3404d",
- "workspace_id": "bc54b16a-b11a-431c-a742-0cce9bc618ea",
- "name": "Name 1",
- "icon": "Icon 1",
- "conditions": [
- {
- "utm_source": "utm_source1",
- "utm_medium": "utm_medium1",
- "utm_campaign": "utm_campaign1",
- "utm_content": "utm_content1"
}, - {
- "utm_source": "utm_source2",
- "utm_medium": "utm_medium2",
- "utm_campaign": "utm_campaign2",
- "utm_content": "utm_content2"
}
]
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of channel-utm to get or update |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
{- "data": {
- "id": "0db57de4-3ca3-45bd-af38-f6cf63d3404d",
- "workspace_id": "bc54b16a-b11a-431c-a742-0cce9bc618ea",
- "name": "Name 1",
- "icon": "Icon 1",
- "conditions": [
- {
- "utm_source": "utm_source",
- "utm_medium": "utm_medium",
- "utm_campaign": "utm_campaign",
- "utm_content": "utm_content"
}, - {
- "utm_source": "utm_source",
- "utm_medium": "utm_medium",
- "utm_campaign": "utm_campaign",
- "utm_content": "utm_content"
}
]
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of channel-utm to get or update |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| name | string |
| icon | string |
Array of objects (UtmCondition) |
{- "name": "John doe",
- "icon": "left-message",
- "conditions": [
- {
- "utm_source": "utm_source",
- "utm_medium": "utm_medium",
- "utm_campaign": "utm_campaign",
- "utm_content": "utm_content"
}
]
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of channel-utm to get or update |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| name required | string |
| icon required | string |
{- "name": "John doe",
- "icon": "left-arrow"
}{- "data": {
- "__typename": "SimpleChannel",
- "id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "workspace_id": "65f1279c-87cb-4b80-9034-608af2eb45a6",
- "name": "Links",
- "icon": "url",
- "lifetime_value": 0,
- "created_at": "2023-05-09T12:41:13.607Z",
- "updated_at": "2023-05-09T12:41:13.607Z"
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of channel to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of source to get or delete |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
{- "limit": 5,
- "offset": 0,
- "total_count": 10,
- "data": [
- {
- "__typename": "UtmChannel",
- "id": "1b9d6bcd-bbfd-4b1d-9b05-ab8dfbbd4be1",
- "workspace_id": "80fe78d8-a25f-4a2d-8473-dc852658d91a",
- "name": "My Channel",
- "icon": "smile",
- "lifetime_value": 0,
- "created_at": "2023-05-09T12:41:17.378Z",
- "updated_at": "2023-05-09T12:41:17.378Z"
}, - {
- "__typename": "AdChannel",
- "id": "1b9d6bcd-bbfd-4b1d-9b05-ab8dfbbd4be2",
- "workspace_id": "80fe78d8-a25f-4a2d-8473-dc852658d91b",
- "name": "Facebook ads",
- "icon": "facebook",
- "lifetime_value": 0,
- "created_at": "2023-05-09T12:41:17.378Z",
- "updated_at": "2023-05-09T12:41:17.378Z"
}, - {
- "__typename": "SimpleChannel",
- "id": "1b9d6bcd-bbfd-4b1d-9b05-ab8dfbbd4be3",
- "workspace_id": "80fe78d8-a25f-4a2d-8473-dc852658d91c",
- "name": "Twitter channel",
- "icon": "twitter",
- "lifetime_value": 0,
- "created_at": "2023-05-09T12:41:17.378Z",
- "updated_at": "2023-05-09T12:41:17.378Z"
}
]
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of person to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
{- "data": {
- "id": "50bd684d-995c-473f-8cf4-578a4eaacb55",
- "workspace_id": "01cb00c9-8fa2-47f8-b92d-9670fb1fc8b7",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "email": "john.doe@example.com",
- "country_code": "US",
- "phone": "+1 555 555 5555",
- "lifetime_value": 1000,
- "stage": "lead",
- "created_at": "2023-05-12T11:27:10.052Z",
- "updated_at": "2023-05-12T11:27:10.052Z"
}
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of person to get or delete |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
string Filter by email address. | |
| first_name | string Filter by first name. |
| last_name | string Filter by last name. |
| name | string Filter by full name. |
| phone | string Filter by phone number. |
| country_code | string Filter by country code. |
| start_date required | string |
| end_date required | string |
| type required | string |
{- "start_date": "2022-12-01T12:34:56.789Z",
- "end_date": "2022-12-01T12:34:56.789Z",
- "type": "lead"
}{- "limit": 10,
- "offset": 0,
- "total_count": 100,
- "data": [
- {
- "id": "50bd684d-995c-473f-8cf4-578a4eaacb55",
- "workspace_id": "01cb00c9-8fa2-47f8-b92d-9670fb1fc8b7",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "email": "john.doe@example.com",
- "country_code": "US",
- "phone": "+1 555 555 5555",
- "lifetime_value": 1000,
- "stage": "lead",
- "created_at": "2023-05-12T11:27:10.052Z",
- "updated_at": "2023-05-12T11:27:10.052Z"
}, - {
- "id": "50bd684d-995c-473f-8cf4-578a4eaacb56",
- "workspace_id": "01cb00c9-8fa2-47f8-b92d-9670fb1fc8b7",
- "first_name": "John 2",
- "last_name": "Doe 2",
- "name": "John Doe 2",
- "email": "john.doe2@example.com",
- "country_code": "UK",
- "phone": "+1 555 555 5550",
- "lifetime_value": 999,
- "stage": "lead",
- "created_at": "2023-05-12T11:27:10.052Z",
- "updated_at": "2023-05-12T11:27:10.052Z"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| time required | number |
| form_type | string |
| form_id | string |
| country | string |
| email required | string |
| phone | string |
| first_name | string |
| last_name | string |
| name | string |
| session_id | string |
| ip_address | string |
| device | string |
| website | string |
| href | string |
| utm_source | string |
| utm_medium | string |
| utm_campaign | string |
| utm_content | string |
| fbclid | string |
| gclid | string |
{- "time": 12333020333,
- "form_type": "newsletter",
- "form_id": "123e4567-e89b-12d3-a456-426655440003",
- "country": "US",
- "email": "john_doe@example.com",
- "phone": 928002271555,
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "session_id": "123e4567-e89b-12d3-a456-426655440003",
- "ip_address": "1.1.1.1",
- "device": "mobile",
- "website": "www.example.com",
- "utm_source": "facebook",
- "utm_medium": "social",
- "utm_campaign": "black-friday",
- "utm_content": "special-promo",
- "fbclid": "facebook click id",
- "gclid": "google click id"
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| time required | number |
| parent_id | string |
| transaction_id required | string |
| transaction_type required | string |
| transaction_amount required | number |
| transaction_description required | string |
| country | string |
| email required | string |
| phone | string |
| first_name | string |
| last_name | string |
| name | string |
| session_id | string |
| ip_address | string |
| utm_source | string |
| utm_medium | string |
| utm_campaign | string |
| utm_content | string |
| fbclid | string |
| gclid | string |
| platform | string |
| platform_id | string |
{- "time": 12333020333,
- "parent_id": "abc123",
- "transaction_id": "abc123",
- "transaction_type": "order-success",
- "transaction_amount": 18000,
- "transaction_description": "Purchase of abc",
- "country": "US",
- "email": "john_doe@example.com",
- "phone": 928002271555,
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "session_id": "123e4567-e89b-12d3-a456-426655440003",
- "ip_address": "1.1.1.1",
- "utm_source": "facebook",
- "utm_medium": "social",
- "utm_campaign": "black-friday",
- "utm_content": "special-promo",
- "fbclid": "facebook click id",
- "gclid": "google click id",
- "platform": "thrivecart",
- "platform_id": "thrivecart_user_id"
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| id | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: id=123e4567-e89b-12d3-a456-426655440000 Visitor Id if you want to filter |
| limit | number Example: limit=1 Limit for pagination |
| offset | number Example: offset=1 Limit for pagination |
| start_date required | number |
| end_date required | number |
{- "start_date": 1686434400000,
- "end_date": 1686434400000
}{- "limit": 5,
- "offset": 0,
- "total_count": 10,
- "data": [
- {
- "id": "123e4567-e89b-12d3-a456-426655440000",
- "workspace_id": "123e4567-e89b-12d3-a456-426655440000",
- "page_id": "123e4567-e89b-12d3-a456-426655440000",
- "website_id": "123e4567-e89b-12d3-a456-426655440000",
- "ad_id": null,
- "platform_id": "1a426655440000",
- "form_id": "123e4567-e89b-12d3-a456-426655440000",
- "transaction_id": "123e4567-e89b",
- "source_id": "123e4567-e89b-12d3-a456-426655440000",
- "wb_form_id": "123e4567-e89b-12d3-a456-426655440000",
- "wb_product_id": "123e4567-e89b-12d3-a456-426655440000",
- "time": "2023-09-02 03:09:21.000 +0500",
- "event": "event1",
- "utm_source": "source",
- "utm_medium": "medium",
- "utm_campaign": "campaign",
- "utm_content": "content",
- "email": "user@xyz.com",
- "name": "name",
- "first_name": "first_name",
- "last_name": "last_name",
- "phone": 9202091,
- "country": "china",
- "form_type": "type-a",
- "path_name": "path-x",
- "email_input_name": "inputname",
- "platform": "platform-x",
- "device": "mobile",
- "user_agent": "mozilla",
- "referrer": "paul",
- "new_session": "123e4567-e89b-12d3-a456-426655440000",
- "ad_source": null,
- "description": "desc",
- "amount": 123,
- "parent_transaction_eid": "123a40000",
- "visitor_id": "123e4567-e89b-12d3-a456-426655440000",
- "ip_address": "192.168.1.1",
- "host_name": "aurora",
- "page_url": "xyz/page1",
- "fbclid": "abd877172",
- "gclid": "ua818211",
- "person_id": "123e4567-e89b-12d3-a456-426655440000"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request. |
| event_name | string Example: event_name=order-success Can be order-success, order-recurring, order-refund or form-submit. |
| id | string Filter by event ID. |
| visitor_id | string Filter by visitor ID. |
| country | string Filter by country code. |
| device | string Filter by device type. |
| name | string Filter by name. |
string Filter by email address. | |
| first_name | string Filter by first name. |
| last_name | string Filter by last name. |
| phone | string Filter by phone number. |
| first_page_id | string Filter by first page ID. |
| first_page_href | string Filter by the href of the first page. |
| first_website_id | string Filter by the first website ID. |
| first_page_hostname | string Filter by the hostname of the first page. |
| first_source_id | string Filter by first source ID. |
| first_utm_source | string Filter by the first UTM source. |
| first_utm_medium | string Filter by the first UTM medium. |
| first_utm_campaign | string Filter by the first UTM campaign. |
| first_utm_content | string Filter by the first UTM content. |
| first_ad_name | string Filter by the name of the first ad. |
| first_ad_set_name | string Filter by the name of the first ad set. |
| first_ad_campaign_name | string Filter by the name of the first ad campaign. |
| first_channel_id | string Filter by the first channel ID. |
| first_channel_name | string Filter by the name of the first channel. |
| last_page_id | string Filter by last page ID. |
| last_page_href | string Filter by the href of the last page. |
| last_website_id | string Filter by the last website ID. |
| last_page_hostname | string Filter by the hostname of the last page. |
| last_source_id | string Filter by last source ID. |
| last_utm_source | string Filter by the last UTM source. |
| last_utm_medium | string Filter by the last UTM medium. |
| last_utm_campaign | string Filter by the last UTM campaign. |
| last_utm_content | string Filter by the last UTM content. |
| last_ad_name | string Filter by the name of the last ad. |
| last_ad_set_name | string Filter by the name of the last ad set. |
| last_ad_campaign_name | string Filter by the name of the last ad campaign. |
| last_channel_id | string Filter by the last channel ID. |
| last_channel_name | string Filter by the name of the last channel. |
| limit | number Example: limit=10 Limit for pagination, specifies the number of items to return. |
| offset | number Example: offset=0 Offset for pagination, specifies the starting position of the query. |
| start_date required | number |
| end_date required | number |
{- "start_date": 1686434400000,
- "end_date": 1686434400000
}{- "limit": 5,
- "offset": 0,
- "total_count": 10,
- "data": [
- {
- "id": "123e4567-e89b-12d3-a456-426655440000",
- "workspace_id": "123e4567-e89b-12d3-a456-426655440000",
- "page_id": "123e4567-e89b-12d3-a456-426655440000",
- "website_id": "123e4567-e89b-12d3-a456-426655440000",
- "ad_id": null,
- "platform_id": "1a426655440000",
- "form_id": "123e4567-e89b-12d3-a456-426655440000",
- "transaction_id": "123e4567-e89b",
- "source_id": "123e4567-e89b-12d3-a456-426655440000",
- "wb_form_id": "123e4567-e89b-12d3-a456-426655440000",
- "wb_product_id": "123e4567-e89b-12d3-a456-426655440000",
- "time": "2023-09-02 03:09:21.000 +0500",
- "event": "event1",
- "utm_source": "source",
- "utm_medium": "medium",
- "utm_campaign": "campaign",
- "utm_content": "content",
- "email": "user@xyz.com",
- "name": "name",
- "first_name": "first_name",
- "last_name": "last_name",
- "phone": 9202091,
- "country": "china",
- "form_type": "type-a",
- "path_name": "path-x",
- "email_input_name": "inputname",
- "platform": "platform-x",
- "device": "mobile",
- "user_agent": "mozilla",
- "referrer": "paul",
- "new_session": "123e4567-e89b-12d3-a456-426655440000",
- "ad_source": null,
- "description": "desc",
- "amount": 123,
- "parent_transaction_eid": "123a40000",
- "visitor_id": "123e4567-e89b-12d3-a456-426655440000",
- "ip_address": "192.168.1.1",
- "host_name": "aurora",
- "page_url": "xyz/page1",
- "fbclid": "abd877172",
- "gclid": "ua818211",
- "person_id": "123e4567-e89b-12d3-a456-426655440000"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| name required | string |
required | Array of objects (ProductCondition) |
{- "name": "Product One",
- "product_conditions": [
- {
- "description_like": "description_like"
}, - {
- "price_min": 100
}, - {
- "price_max": 200
}, - {
- "id_equal": "id_equal"
}
]
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of product to delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID is required in every request |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of product to get or delete |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
{- "limit": 10,
- "offset": 0,
- "total_count": 12,
- "data": [
- {
- "id": "b51f0d0a-b790-11ed-afa1-0242ac120002",
- "name": "name",
- "product_conditions": [
- {
- "id_equal": "id_equal1",
- "description_like": "description_like1",
- "price_min": 5,
- "price_max": 10
}, - {
- "id_equal": "id_equal2",
- "description_like": "description_like2",
- "price_min": 30,
- "price_max": 15
}
]
}, - {
- "id": "b51f0d0a-b790-11ed-afa1-0242ac120002",
- "name": "name",
- "product_conditions": [
- {
- "id_equal": "id_equal1",
- "description_like": "description_like1",
- "price_min": 5,
- "price_max": 10
}, - {
- "id_equal": "id_equal2",
- "description_like": "description_like2",
- "price_min": 30,
- "price_max": 15
}
]
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| form_type required | string^.{0,2}$ |
| name required | string |
required | Array of objects (FormCondition) |
{- "name": "John doe",
- "icon": "left-message",
- "form_conditions": [
- {
- "id_equal": "id_equal"
}, - {
- "input_field_name": "input_field_name"
}, - {
- "input_field_id": "input_field_id"
}, - {
- "href_contain": "href_contain"
}, - {
- "hostname_equal": "hostname_equal"
}
]
}{- "data": {
- "id": "b51f0d0a-b790-11ed-afa1-0242ac120002",
- "name": "name",
- "form_type": "form_type",
- "form_conditions": [
- {
- "id_equal": "id_equal1",
- "input_field_name": "input_field_name1",
- "input_field_id": "input_field_id1",
- "href_contain": "href_contain1",
- "hostname_equal": "hostname_equal1"
}, - {
- "iq_equal": "id_equal2",
- "input_field_name": "input_field_name2",
- "input_field_id": "input_field_id2",
- "href_contain": "href_contain2",
- "hostname_equal": "hostname_equal2"
}
]
}
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of form to delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of form to get or delete |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of form to get or delete |
| limit | number Example: limit=1 How many elements you want to fetch |
| offset | number Example: offset=1 offset from where you want to start the list |
{- "limit": 10,
- "offset": 0,
- "total_count": 12,
- "data": [
- {
- "id": "b51f0d0a-b790-11ed-afa1-0242ac120002",
- "name": "name",
- "form_type": "form_type",
- "form_conditions": [
- {
- "id_equal": "id_equal1",
- "input_field_name": "input_field_name1",
- "input_field_id": "input_field_id1",
- "href_contain": "href_contain1",
- "hostname_equal": "hostname_equal1"
}, - {
- "iq_equal": "id_equal2",
- "input_field_name": "input_field_name2",
- "input_field_id": "input_field_id2",
- "href_contain": "href_contain2",
- "hostname_equal": "hostname_equal2"
}
]
}, - {
- "id": "b51f0d0a-b790-11ed-afa1-0242ac120002",
- "name": "name",
- "form_type": "form_type",
- "form_conditions": [
- {
- "id_equal": "id_equal1",
- "input_field_name": "input_field_name1",
- "input_field_id": "input_field_id1",
- "href_contain": "href_contain1",
- "hostname_equal": "hostname_equal1"
}, - {
- "iq_equal": "id_equal2",
- "input_field_name": "input_field_name2",
- "input_field_id": "input_field_id2",
- "href_contain": "href_contain2",
- "hostname_equal": "hostname_equal2"
}
]
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
{- "total_count": 10,
- "limit": 5,
- "offset": 0,
- "data": [
- {
- "id": "593f979b-0943-575c-b1bf-80954d41bf17",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "domain": "example1.com",
- "updated_at": "2022-10-11 16:59:28.000 +0500,",
- "last_session_id": "5a7959e-42ef-4dbd-afab-133de773e11a"
}, - {
- "id": "593f979b-0943-575c-b1bf-80954d41bf18",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11b",
- "domain": "example2.com",
- "updated_at": "2022-10-11 16:59:28.000 +0500,",
- "last_session_id": "5a7959e-42ef-4dbd-afab-133de773e11a"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| website_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: website_id=123e4567-e89b-12d3-a456-426655440000 Website ID of the pages fetch |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
{- "total_count": 10,
- "limit": 5,
- "offset": 0,
- "data": [
- {
- "id": "593f979b-0943-575c-b1bf-80954d41bf17",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "website_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "domain": "example1.com",
- "updated_at": "2022-10-11 16:59:28.000 +0500,",
- "last_session_id": "5a7959e-42ef-4dbd-afab-133de773e11a"
}, - {
- "id": "593f979b-0943-575c-b1bf-80954d41bf17",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "website_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "domain": "example2.com",
- "updated_at": "2022-10-11 16:59:28.000 +0500,",
- "last_session_id": "5a7959e-42ef-4dbd-afab-133de773e11a"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| search required | string Example: search=example.com/landing Search string |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
{- "total_count": 10,
- "limit": 5,
- "offset": 0,
- "data": [
- {
- "id": "593f979b-0943-575c-b1bf-80954d41bf17",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "website_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "domain": "example1.com",
- "updated_at": "2022-10-11 16:59:28.000 +0500,",
- "last_session_id": "5a7959e-42ef-4dbd-afab-133de773e11a"
}, - {
- "id": "593f979b-0943-575c-b1bf-80954d41bf17",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "website_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "domain": "example2.com",
- "updated_at": "2022-10-11 16:59:28.000 +0500,",
- "last_session_id": "5a7959e-42ef-4dbd-afab-133de773e11a"
}
]
}| id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: 123e4567-e89b-12d3-a456-426655440000 The id of page |
| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 The workspace_id of form to get or delete |
{- "id": "c6239f3b-3b49-51b7-84c6-cf6e1621b8f5",
- "workspace_id": "123e4567-e89b-12d3-a456-426655440000",
- "website_id": "123e4567-e89b-12d3-a456-426655440000",
- "href": "/page.html",
- "updated_at": "2023-03-29T00:00:00.000Z",
- "last_session_id": "123e4567-e89b-12d3-a456-426655440000"
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| limit | number Example: limit=2 Limit of objects to get |
| offset | number Example: offset=5 skip number of objects to get in list |
| start_date required | string |
| end_date required | string |
{- "start_date": "2022-01-02T00:00:00Z",
- "end_date": "2022-01-02T00:00:00Z"
}{- "total_count": 10,
- "limit": 5,
- "offset": 0,
- "data": [
- {
- "id": "593f979b-0943-575c-b1bf-80954d41bf17",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "ip_address": "193.168.1.1",
- "country_code": "US",
- "device": "Mobile",
- "user-agent": "Mozilla-firefox",
- "updated_at": "2022-10-11 16:59:28.000 +0500"
}, - {
- "id": "593f979b-0943-575c-b1bf-80954d41bf18",
- "workspace_id": "5a7959e-42ef-4dbd-afab-133de773e11a",
- "ip_address": "193.168.1.1",
- "country_code": "US",
- "device": "Desktop",
- "user-agent": "Mozilla-firefox",
- "updated_at": "2022-10-11 16:59:28.000 +0500"
}
]
}| workspace_id required | string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89... Example: workspace_id=123e4567-e89b-12d3-a456-426655440000 Workspace ID required |
| query required | string |
{- "query": "Select * from xyz"
}{- "data": [
- {
- "page_views": 101,
- "form_submits": 102,
- "orders": 103,
- "orders_amount": 104,
- "pages_href": "example.com/page1"
}, - {
- "page_views": 201,
- "form_submits": 202,
- "orders": 203,
- "orders_amount": 204,
- "pages_href": "example.com/page2"
}
]
}