Funnel reports

GET

/api/v1/analytics/funnels

const url = 'https://digize.com/api/v1/analytics/funnels';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/analytics/funnels \
  --header 'x-api-key: <x-api-key>'

Each funnel with how many reached each step in the last 30 days and the 30 before, 12 weeks of who started and finished, and the last 30 days by source. Order and checkout steps count Commerce’s own records.

Needs the analytics:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

unavailable

required

Any of:

object
null

object

reason

required

string

Allowed values: token permission upstream

message

required

string

funnels

required

Array<object>

object

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

detail

required

string

count

required

Reached it in the last 30 days.

number

previous

required

Reached it in the 30 days before.

number

weeks

required

Array<object>

object

week

required

string format: date-time

entered

required

number

converted

required

number

sources

required

Array<object>

object

label

required

string

entered

required

number

converted

required

number

Example

{
  "unavailable": {
    "reason": "token"
  },
  "funnels": [
    {
      "steps": [
        {
          "kind": "page"
        }
      ]
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/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.

application/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.

application/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).

application/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.

application/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"
  }
}