Funnels

Download schema

Ordered page flows.

List funnels

GET

https://automation.atomicat-api.com/api/automation/v1

/funnels

This API does not delete funnels.

Required scope: funnels:read.

List funnels › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

project_id

string

Only records in this project.

List funnels › Responses

Matching records. The body is a JSON array.

Funnel[]

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Create a funnel

POST

https://automation.atomicat-api.com/api/automation/v1

/funnels

Each page entry needs pageId or url, plus pageType.

Required scope: funnels:write.

Create a funnel › Request Body

FunnelCreate

name

string · required

Funnel name.

project_id

string

Project id.

FunnelPage[]

Steps. Each item needs pageId or url.

Create a funnel › Responses

The created funnel.

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

POST/funnels

curl --request POST \
  --url https://automation.atomicat-api.com/api/automation/v1/funnels \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "project_id": "project_id",
  "pages": [
    {
      "pageId": "pageId",
      "url": "url",
      "pageType": "pageType"
    }
  ]
}
'

Example Request Body

{
  "name": "name",
  "project_id": "project_id",
  "pages": [
    {
      "pageId": "pageId",
      "url": "url",
      "pageType": "pageType"
    }
  ]
}

json

Example Responses

{
  "id": "funnel_123",
  "name": "Main funnel",
  "site_id": null,
  "project_id": "project_123",
  "status": null,
  "pages": [],
  "page_ids": "",
  "steps": [],
  "created_at": null,
  "updated_at": null
}

json

application/json

Update a funnel

PATCH

https://automation.atomicat-api.com/api/automation/v1

/funnels

funnel_id is required. pages replaces the step list when you send it.

Required scope: funnels:write.

Update a funnel › Request Body

FunnelUpdate

funnel_id

string · required

Funnel id.

name

string

New name.

FunnelPage[]

Update a funnel › Responses

The updated funnel.

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

PATCH/funnels

curl --request PATCH \
  --url https://automation.atomicat-api.com/api/automation/v1/funnels \
  --header 'Content-Type: application/json' \
  --data '
{
  "funnel_id": "funnel_id",
  "name": "name",
  "pages": [
    {
      "pageId": "pageId",
      "url": "url",
      "pageType": "pageType"
    }
  ]
}
'

Example Request Body

{
  "funnel_id": "funnel_id",
  "name": "name",
  "pages": [
    {
      "pageId": "pageId",
      "url": "url",
      "pageType": "pageType"
    }
  ]
}

json

Example Responses

{
  "id": "funnel_123",
  "name": "Main funnel",
  "site_id": null,
  "project_id": null,
  "status": null,
  "pages": [],
  "page_ids": "",
  "steps": [],
  "created_at": null,
  "updated_at": null
}

json

application/json

Search funnels

GET

https://automation.atomicat-api.com/api/automation/v1

/search/funnels

Required scope: funnels:read.

Search funnels › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

query

string

Case-insensitive text matched against the record name and related fields.

project_id

string

Only records in this project.

funnel_id

string

Exact funnel id.

Search funnels › Responses

Matching records. The body is a JSON array.

Funnel[]

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Get a funnel

GET

https://automation.atomicat-api.com/api/automation/v1

/funnels/{funnelId}

Required scope: funnels:read.

Get a funnel › path Parameters

funnelId

string · required

Funnel id.

Get a funnel › Responses

The funnel.

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Quizzes Videos

List funnels

GET

https://automation.atomicat-api.com/api/automation/v1

/funnels

This API does not delete funnels.

Required scope: funnels:read.

List funnels › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

project_id

string

Only records in this project.

List funnels › Responses

Matching records. The body is a JSON array.

Funnel[]

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Create a funnel

POST

https://automation.atomicat-api.com/api/automation/v1

/funnels

Each page entry needs pageId or url, plus pageType.

Required scope: funnels:write.

Create a funnel › Request Body

FunnelCreate

name

string · required

Funnel name.

project_id

string

Project id.

FunnelPage[]

Steps. Each item needs pageId or url.

Create a funnel › Responses

The created funnel.

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Update a funnel

PATCH

https://automation.atomicat-api.com/api/automation/v1

/funnels

funnel_id is required. pages replaces the step list when you send it.

Required scope: funnels:write.

Update a funnel › Request Body

FunnelUpdate

funnel_id

string · required

Funnel id.

name

string

New name.

FunnelPage[]

Update a funnel › Responses

The updated funnel.

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Search funnels

GET

https://automation.atomicat-api.com/api/automation/v1

/search/funnels

Required scope: funnels:read.

Search funnels › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

query

string

Case-insensitive text matched against the record name and related fields.

project_id

string

Only records in this project.

funnel_id

string

Exact funnel id.

Search funnels › Responses

Matching records. The body is a JSON array.

Funnel[]

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Get a funnel

GET

https://automation.atomicat-api.com/api/automation/v1

/funnels/{funnelId}

Required scope: funnels:read.

Get a funnel › path Parameters

funnelId

string · required

Funnel id.

Get a funnel › Responses

The funnel.

Funnel

id

string

Funnel id.

name

string

Funnel name.

site_id

string | null

Site id.

project_id

string | null

Project id.

status

string | null

Funnel status.

array

Page ids or page step objects stored on the funnel.

page_ids

string

Comma-separated page ids when pages is an array of ids.

object[]

Step objects when the funnel stores them.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.