Add a funnel

POST

/api/v1/analytics/funnels

curl --request POST \
  --url https://digize.com/api/v1/analytics/funnels \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "name": "example", "description": "example", "steps": [ { "label": "example", "kind": "page", "match": "example" } ] }'

• Digize

Adds a funnel of 2 to 10 steps. A page or event step counts visitors who reached it and every page or event step before it; form, checkout and order steps count those records.

Needs the analytics:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

name

required

string

<= 60 characters

description

string

<= 200 characters

steps

required

Array<object>

>= 2 items <= 10 items

object

label

required

string

<= 60 characters

kind

required

string

Allowed values: page event form checkout order

match

required

A path (/products/*), an event name, a form name, or empty for checkouts and orders.

string

<= 200 characters

Responses

201

Done

Media typeapplication/json

object

id

required

string

name

required

string

description

required

string

steps

required

Array<object>

object

label

required

string

<= 60 characters

kind

required

string

Allowed values: page event form checkout order

match

required

A path (/products/*), an event name, a form name, or empty for checkouts and orders.

string

<= 200 characters

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "steps": [
    {
      "kind": "page"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}