Funnels

Download schema

Flujos ordenados de páginas.

Listar embudos

GET

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

/funnels

Esta API no elimina embudos.

Alcance requerido: funnels:read.

Listar embudos › query Parameters

limit

integer · min: 1 · max: 100

Cantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.

Default: 50

project_id

string

Solo registros de este proyecto.

Listar embudos › Responses

Registros coincidentes. El cuerpo es un arreglo JSON.

Funnel[]

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

Crear un embudo

POST

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

/funnels

Cada página necesita pageId o url, y pageType.

Alcance requerido: funnels:write.

Crear un embudo › Request Body

FunnelCreate

name

string · required

Nombre del embudo.

project_id

string

Id del proyecto.

FunnelPage[]

Pasos. Cada uno necesita pageId o url.

Crear un embudo › Responses

El embudo creado.

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo 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

Actualizar un embudo

PATCH

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

/funnels

funnel_id es obligatorio. pages reemplaza la lista de pasos cuando lo envías.

Alcance requerido: funnels:write.

Actualizar un embudo › Request Body

FunnelUpdate

funnel_id

string · required

Id del embudo.

name

string

Nuevo nombre.

FunnelPage[]

Actualizar un embudo › Responses

El embudo actualizado.

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo 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 embudos

GET

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

/search/funnels

Alcance requerido: funnels:read.

Buscar embudos › query Parameters

limit

integer · min: 1 · max: 100

Cantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.

Default: 50

query

string

Texto sin distinción de mayúsculas que se compara con el nombre y los campos relacionados.

project_id

string

Solo registros de este proyecto.

funnel_id

string

Id exacto.

Buscar embudos › Responses

Registros coincidentes. El cuerpo es un arreglo JSON.

Funnel[]

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

Obtener un embudo

GET

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

/funnels/{funnelId}

Alcance requerido: funnels:read.

Obtener un embudo › path Parameters

funnelId

string · required

Id del embudo.

Obtener un embudo › Responses

El embudo.

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

Quizzes Videos

Listar embudos

GET

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

/funnels

Esta API no elimina embudos.

Alcance requerido: funnels:read.

Listar embudos › query Parameters

limit

integer · min: 1 · max: 100

Cantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.

Default: 50

project_id

string

Solo registros de este proyecto.

Listar embudos › Responses

Registros coincidentes. El cuerpo es un arreglo JSON.

Funnel[]

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

Crear un embudo

POST

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

/funnels

Cada página necesita pageId o url, y pageType.

Alcance requerido: funnels:write.

Crear un embudo › Request Body

FunnelCreate

name

string · required

Nombre del embudo.

project_id

string

Id del proyecto.

FunnelPage[]

Pasos. Cada uno necesita pageId o url.

Crear un embudo › Responses

El embudo creado.

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

Actualizar un embudo

PATCH

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

/funnels

funnel_id es obligatorio. pages reemplaza la lista de pasos cuando lo envías.

Alcance requerido: funnels:write.

Actualizar un embudo › Request Body

FunnelUpdate

funnel_id

string · required

Id del embudo.

name

string

Nuevo nombre.

FunnelPage[]

Actualizar un embudo › Responses

El embudo actualizado.

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

Buscar embudos

GET

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

/search/funnels

Alcance requerido: funnels:read.

Buscar embudos › query Parameters

limit

integer · min: 1 · max: 100

Cantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.

Default: 50

query

string

Texto sin distinción de mayúsculas que se compara con el nombre y los campos relacionados.

project_id

string

Solo registros de este proyecto.

funnel_id

string

Id exacto.

Buscar embudos › Responses

Registros coincidentes. El cuerpo es un arreglo JSON.

Funnel[]

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

Obtener un embudo

GET

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

/funnels/{funnelId}

Alcance requerido: funnels:read.

Obtener un embudo › path Parameters

funnelId

string · required

Id del embudo.

Obtener un embudo › Responses

El embudo.

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.