Funnels

Download schema

Fluxos ordenados de páginas.

Listar funis

GET

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

/funnels

Esta API não exclui funis.

Escopo exigido: funnels:read.

Listar funis › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

project_id

string

Apenas registros deste projeto.

Listar funis › Responses

Registros correspondentes. O corpo é um array JSON.

Funnel[]

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar um funil

POST

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

/funnels

Cada página precisa de pageId ou url, e pageType.

Escopo exigido: funnels:write.

Criar um funil › Request Body

FunnelCreate

name

string · required

Nome do funil.

project_id

string

Id do projeto.

FunnelPage[]

Passos. Cada um precisa de pageId ou url.

Criar um funil › Responses

O funil criado.

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

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

Atualizar um funil

PATCH

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

/funnels

funnel_id é obrigatório. pages substitui a lista de passos quando enviado.

Escopo exigido: funnels:write.

Atualizar um funil › Request Body

FunnelUpdate

funnel_id

string · required

Id do funil.

name

string

Novo nome.

FunnelPage[]

Atualizar um funil › Responses

O funil atualizado.

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

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

Buscar funis

GET

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

/search/funnels

Escopo exigido: funnels:read.

Buscar funis › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

query

string

Texto sem distinção de maiúsculas comparado com o nome e os campos relacionados.

project_id

string

Apenas registros deste projeto.

funnel_id

string

Id exato.

Buscar funis › Responses

Registros correspondentes. O corpo é um array JSON.

Funnel[]

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Obter um funil

GET

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

/funnels/{funnelId}

Escopo exigido: funnels:read.

Obter um funil › path Parameters

funnelId

string · required

Id do funil.

Obter um funil › Responses

O funil.

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Quizzes Videos

Listar funis

GET

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

/funnels

Esta API não exclui funis.

Escopo exigido: funnels:read.

Listar funis › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

project_id

string

Apenas registros deste projeto.

Listar funis › Responses

Registros correspondentes. O corpo é um array JSON.

Funnel[]

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar um funil

POST

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

/funnels

Cada página precisa de pageId ou url, e pageType.

Escopo exigido: funnels:write.

Criar um funil › Request Body

FunnelCreate

name

string · required

Nome do funil.

project_id

string

Id do projeto.

FunnelPage[]

Passos. Cada um precisa de pageId ou url.

Criar um funil › Responses

O funil criado.

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Atualizar um funil

PATCH

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

/funnels

funnel_id é obrigatório. pages substitui a lista de passos quando enviado.

Escopo exigido: funnels:write.

Atualizar um funil › Request Body

FunnelUpdate

funnel_id

string · required

Id do funil.

name

string

Novo nome.

FunnelPage[]

Atualizar um funil › Responses

O funil atualizado.

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Buscar funis

GET

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

/search/funnels

Escopo exigido: funnels:read.

Buscar funis › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

query

string

Texto sem distinção de maiúsculas comparado com o nome e os campos relacionados.

project_id

string

Apenas registros deste projeto.

funnel_id

string

Id exato.

Buscar funis › Responses

Registros correspondentes. O corpo é um array JSON.

Funnel[]

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Obter um funil

GET

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

/funnels/{funnelId}

Escopo exigido: funnels:read.

Obter um funil › path Parameters

funnelId

string · required

Id do funil.

Obter um funil › Responses

O funil.

Funnel

id

string

Id do funil.

name

string

Nome.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

status

string | null

Status.

array

Ids de página ou passos salvos no funil.

page_ids

string

Ids separados por vírgula quando pages é um array de ids.

object[]

Passos quando o funil os guarda.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.