Web Funnel Metrics

GET/api/v1/web-funnels

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Query parameters

date_fromstring<date> | any

date_tostring<date> | any

appstring[] | any

funnelstring[] | any

platformstring[] | any

countrystring[] | any

media_sourcestring[] | any

product_namestring[] | any

trial_daysstring[] | any

searchstring | any

Substring match on creative / funnel names

group_bystring[] | any

Dimensions that define a row

date_grainstring

Bucket of the `date` dimension; weeks start on Monday

default: "day"

Allowed:dayweekmonthquarteryear

sort_bystring

default: "spend"

sort_dirstring

default: "desc"

Allowed:ascdesc

date_dirstring

Calendar order of a grouped `date`, within whatever precedes it in `group_by`

default: "desc"

Allowed:ascdesc

sort_modestring

`levels`: each grouped dimension, in `group_by` order, ranked by its own total of `sort_by`

default: "flat"

Allowed:flatlevels

limitinteger

min 1 · max 500 · default: 50

offsetinteger

min 0 · default: 0

Responses

200Successful Response

successboolean

default: true

dataWebFunnelResult | any

Show properties

Any of:

WebFunnelResult

rowsWebFunnelRow[]required

Show properties

Array of WebFunnelRow

spendnumberrequired

purchasesintegerrequired

cpanumber | any

Show properties

Any of:

number

number

any

any

ltvnumber | any

Show properties

Any of:

number

number

any

any

roi_pctnumber | any

Show properties

Any of:

number

number

any

any

profitnumberrequired

trial_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

upsellsintegerrequired

upsells_revenuenumberrequired

app_revenuenumberrequired

conversion_pctnumber | any

Show properties

Any of:

number

number

any

any

first_screen_to_paywall_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

first_screen_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

paywall_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

checkout_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

purchase_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

payment_success_pctnumber | any

Show properties

Any of:

number

number

any

any

funnel_opensintegerrequired

second_screensintegerrequired

paywallsintegerrequired

checkoutsintegerrequired

payment_attemptsintegerrequired

cpmnumber | any

Show properties

Any of:

number

number

any

any

ctr_pctnumber | any

Show properties

Any of:

number

number

any

any

cpcnumber | any

Show properties

Any of:

number

number

any

any

impressionsintegerrequired

clicksintegerrequired

keystringrequired

dimensionsobjectrequired

creativeWebFunnelCreative | any

Show properties

Any of:

WebFunnelCreative

idstringrequired

preview_urlstring | any

Show properties

Any of:

string

string

any

any

any

any

group_keystring | any

Show properties

Any of:

string

string

any

any

totalsWebFunnelMetricsrequired

The measures of one row, or of the whole filtered window. Mirrors `columns.METRICS`.

Show properties

spendnumberrequired

purchasesintegerrequired

cpanumber | any

Show properties

Any of:

number

number

any

any

ltvnumber | any

Show properties

Any of:

number

number

any

any

roi_pctnumber | any

Show properties

Any of:

number

number

any

any

profitnumberrequired

trial_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

upsellsintegerrequired

upsells_revenuenumberrequired

app_revenuenumberrequired

conversion_pctnumber | any

Show properties

Any of:

number

number

any

any

first_screen_to_paywall_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

first_screen_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

paywall_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

checkout_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

purchase_cr_pctnumber | any

Show properties

Any of:

number

number

any

any

payment_success_pctnumber | any

Show properties

Any of:

number

number

any

any

funnel_opensintegerrequired

second_screensintegerrequired

paywallsintegerrequired

checkoutsintegerrequired

payment_attemptsintegerrequired

cpmnumber | any

Show properties

Any of:

number

number

any

any

ctr_pctnumber | any

Show properties

Any of:

number

number

any

any

cpcnumber | any

Show properties

Any of:

number

number

any

any

impressionsintegerrequired

clicksintegerrequired

metaWebFunnelMetarequired

Show properties

totalintegerrequired

limitintegerrequired

offsetintegerrequired

group_bystring[]required

date_fromstring<date>required

date_tostring<date>required

group_dimensionsstring[]

default: []

shared_metricsstring[]

default: []

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/web-funnels" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/web-funnels", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/web-funnels",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "rows": [
      {
        "spend": 0,
        "purchases": 0,
        "cpa": 0,
        "ltv": 0,
        "roi_pct": 0,
        "profit": 0,
        "trial_cr_pct": 0,
        "upsells": 0,
        "upsells_revenue": 0,
        "app_revenue": 0,
        "conversion_pct": 0,
        "first_screen_to_paywall_cr_pct": 0,
        "first_screen_cr_pct": 0,
        "paywall_cr_pct": 0,
        "checkout_cr_pct": 0,
        "purchase_cr_pct": 0,
        "payment_success_pct": 0,
        "funnel_opens": 0,
        "second_screens": 0,
        "paywalls": 0,
        "checkouts": 0,
        "payment_attempts": 0,
        "cpm": 0,
        "ctr_pct": 0,
        "cpc": 0,
        "impressions": 0,
        "clicks": 0,
        "key": "string",
        "dimensions": {
          "property1": "string",
          "property2": "string"
        },
        "creative": {
          "id": "string",
          "preview_url": "string"
        },
        "group_key": "string"
      }
    ],
    "totals": {
      "spend": 0,
      "purchases": 0,
      "cpa": 0,
      "ltv": 0,
      "roi_pct": 0,
      "profit": 0,
      "trial_cr_pct": 0,
      "upsells": 0,
      "upsells_revenue": 0,
      "app_revenue": 0,
      "conversion_pct": 0,
      "first_screen_to_paywall_cr_pct": 0,
      "first_screen_cr_pct": 0,
      "paywall_cr_pct": 0,
      "checkout_cr_pct": 0,
      "purchase_cr_pct": 0,
      "payment_success_pct": 0,
      "funnel_opens": 0,
      "second_screens": 0,
      "paywalls": 0,
      "checkouts": 0,
      "payment_attempts": 0,
      "cpm": 0,
      "ctr_pct": 0,
      "cpc": 0,
      "impressions": 0,
      "clicks": 0
    },
    "meta": {
      "total": 0,
      "limit": 0,
      "offset": 0,
      "group_by": [
        "string"
      ],
      "date_from": "2019-08-24",
      "date_to": "2019-08-24",
      "group_dimensions": [],
      "shared_metrics": []
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}