Ad Source API (1.0.0)

Download OpenAPI specification:Download

Manage ad sources

Ad Sources

Gets a ad source

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a ad source

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

List of ad sources

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "total_count": 20,
  • "data": [
    ]
}

UTM Sources

Get a utm source

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a utm source

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

List of sources

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "total_count": 20,
  • "data": [
    ]
}

Source

Add a source

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
name
required
string
channel_id
required
string^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Responses

Request samples

Content type
application/json
{
  • "name": "John",
  • "channel_id": "123e4567-e89b-12d3-a456-426655440000"
}

Get a source

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a source

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

List of sources

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "total_count": 20,
  • "data": [
    ]
}

Ad Channels

Add an ad channel

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
name
required
string
icon
required
string
ad_platform
required
string
ad_account_id
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "John doe",
  • "icon": "example@hello.com",
  • "ad_platform": "v71271h812",
  • "ad_account_id": 636367618627
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Gets an ad channel

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes ad channel

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Update a ad channel

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Request Body schema: application/json
required
name
string
icon
string

Responses

Request samples

Content type
application/json
{
  • "name": "John doe",
  • "icon": "left-message"
}

UTM Channel

Add a utm channel

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
name
required
string
icon
required
string
required
Array of objects (UtmCondition)

Responses

Request samples

Content type
application/json
{
  • "name": "John doe",
  • "icon": "left-message",
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a utm channel

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a utm channel

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Request Body schema: application/json
required
name
string
icon
string
Array of objects (UtmCondition)

Responses

Request samples

Content type
application/json
{
  • "name": "John doe",
  • "icon": "left-message",
  • "conditions": [
    ]
}

Deletes a channel

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Channels

Add a channel

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
name
required
string
icon
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "John doe",
  • "icon": "left-arrow"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a channel

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

List of channels

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "limit": 5,
  • "offset": 0,
  • "total_count": 10,
  • "data": [
    ]
}

Person

Get a person

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List of persons

Authorizations:
customAuthorizer
query Parameters
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

email
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.

Request Body schema: application/json
required
start_date
required
string
end_date
required
string
type
required
string

Responses

Request samples

Content type
application/json
{
  • "start_date": "2022-12-01T12:34:56.789Z",
  • "end_date": "2022-12-01T12:34:56.789Z",
  • "type": "lead"
}

Response samples

Content type
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "total_count": 100,
  • "data": [
    ]
}

Event

Create form submit event

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
time
required
number
form_type
string
form_id
string
country
string
email
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

Responses

Request samples

Content type
application/json
{
  • "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"
}

Create transaction event

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
time
required
number
parent_id
string
transaction_id
required
string
transaction_type
required
string
transaction_amount
required
number
transaction_currency
string
transaction_description
required
string
country
string
email
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

Responses

Request samples

Content type
application/json
{
  • "time": 12333020333,
  • "parent_id": "abc123",
  • "transaction_id": "abc123",
  • "transaction_type": "order-success",
  • "transaction_amount": 18000,
  • "transaction_currency": "USD",
  • "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"
}

Get events

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
start_date
required
number
end_date
required
number

Responses

Request samples

Content type
application/json
{
  • "start_date": 1686434400000,
  • "end_date": 1686434400000
}

Response samples

Content type
application/json
{
  • "limit": 5,
  • "offset": 0,
  • "total_count": 10,
  • "data": [
    ]
}

Get conversion events

Authorizations:
customAuthorizer
query Parameters
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.

Request Body schema: application/json
required
event_name
string
start_date
required
number
end_date
required
number
id
string
visitor_id
string
country
string
device
string
email
string
first_name
string
last_name
string
phone
string
first_page_id
string
first_page_href
string
first_website_id
string
first_page_hostname
string
first_source_id
string
first_utm_source
string
first_utm_medium
string
first_utm_campaign
string
first_utm_content
string
first_ad_name
string
first_ad_set_name
string
first_ad_campaign_name
string
first_channel_id
string
first_channel_name
string
last_page_id
string
last_page_href
string
last_website_id
string
last_page_hostname
string
last_source_id
string
last_utm_source
string
last_utm_medium
string
last_utm_campaign
string
last_utm_content
string
last_ad_name
string
last_ad_set_name
string
last_ad_campaign_name
string
last_channel_id
string
last_channel_name
string
limit
number
offset
number

Responses

Request samples

Content type
application/json
{
  • "event_name": "order-success",
  • "start_date": 1686434400000,
  • "end_date": 1686434400000,
  • "id": "string",
  • "visitor_id": "string",
  • "country": "string",
  • "device": "string",
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "phone": "string",
  • "first_page_id": "string",
  • "first_page_href": "string",
  • "first_website_id": "string",
  • "first_page_hostname": "string",
  • "first_source_id": "string",
  • "first_utm_source": "string",
  • "first_utm_medium": "string",
  • "first_utm_campaign": "string",
  • "first_utm_content": "string",
  • "first_ad_name": "string",
  • "first_ad_set_name": "string",
  • "first_ad_campaign_name": "string",
  • "first_channel_id": "string",
  • "first_channel_name": "string",
  • "last_page_id": "string",
  • "last_page_href": "string",
  • "last_website_id": "string",
  • "last_page_hostname": "string",
  • "last_source_id": "string",
  • "last_utm_source": "string",
  • "last_utm_medium": "string",
  • "last_utm_campaign": "string",
  • "last_utm_content": "string",
  • "last_ad_name": "string",
  • "last_ad_set_name": "string",
  • "last_ad_campaign_name": "string",
  • "last_channel_id": "string",
  • "last_channel_name": "string",
  • "limit": 10,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "limit": 5,
  • "offset": 0,
  • "total_count": 10,
  • "data": [
    ]
}

Product

Add a product

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
name
required
string
required
Array of objects (ProductCondition)

Responses

Request samples

Content type
application/json
{
  • "name": "Product One",
  • "product_conditions": [
    ]
}

Deletes a product

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

List of products

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "total_count": 12,
  • "data": [
    ]
}

Form

Add a form

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
form_type
required
string^.{0,2}$
name
required
string
required
Array of objects (FormCondition)

Responses

Request samples

Content type
application/json
{
  • "name": "John doe",
  • "icon": "left-message",
  • "form_conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a form

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

List of forms of user

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "total_count": 12,
  • "data": [
    ]
}

Page

Get a list of websites

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "total_count": 10,
  • "limit": 5,
  • "offset": 0,
  • "data": [
    ]
}

Get a list of all pages of a website

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "total_count": 10,
  • "limit": 5,
  • "offset": 0,
  • "data": [
    ]
}

Search list of pages

Authorizations:
customAuthorizer
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "total_count": 10,
  • "limit": 5,
  • "offset": 0,
  • "data": [
    ]
}

Get page by id

Authorizations:
customAuthorizer
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "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"
}

Visitor

Get a list of visitors

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
start_date
required
string
end_date
required
string

Responses

Request samples

Content type
application/json
{
  • "start_date": "2022-01-02T00:00:00Z",
  • "end_date": "2022-01-02T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "total_count": 10,
  • "limit": 5,
  • "offset": 0,
  • "data": [
    ]
}

Reports

Get a report

Authorizations:
customAuthorizer
query Parameters
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

Request Body schema: application/json
required
query
required
string

Responses

Request samples

Content type
application/json
{
  • "query": "Select * from xyz"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}