Preview Funnel

Analyse an unsaved funnel definition.

curl -X POST "https://api.beacon.hard.al/v1/funnels/preview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "steps": [
    {
      "stepOrder": 1,
      "stepType": "event",
      "stepValue": "page_view"
    },
    {
      "stepOrder": 2,
      "stepType": "event",
      "stepValue": "purchase"
    }
  ],
  "breakdowns": []
}'

import requests
import json

url = "https://api.beacon.hard.al/v1/funnels/preview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "steps": [
    {
      "stepOrder": 1,
      "stepType": "event",
      "stepValue": "page_view"
    },
    {
      "stepOrder": 2,
      "stepType": "event",
      "stepValue": "purchase"
    }
  ],
  "breakdowns": []
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.beacon.hard.al/v1/funnels/preview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "steps": [
    {
      "stepOrder": 1,
      "stepType": "event",
      "stepValue": "page_view"
    },
    {
      "stepOrder": 2,
      "stepType": "event",
      "stepValue": "purchase"
    }
  ],
  "breakdowns": []
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "steps": [
    {
      "stepOrder": 1,
      "stepType": "event",
      "stepValue": "page_view"
    },
    {
      "stepOrder": 2,
      "stepType": "event",
      "stepValue": "purchase"
    }
  ],
  "breakdowns": []
}`)

    req, err := http.NewRequest("POST", "https://api.beacon.hard.al/v1/funnels/preview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.beacon.hard.al/v1/funnels/preview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "steps": [
    {
      "stepOrder": 1,
      "stepType": "event",
      "stepValue": "page_view"
    },
    {
      "stepOrder": 2,
      "stepType": "event",
      "stepValue": "purchase"
    }
  ],
  "breakdowns": []
}'

response = http.request(request)
puts response.body

{
  "success": true,
  "data": {
    "range": {
      "startDate": "2026-10-01",
      "endDate": "2026-10-07",
      "timezone": "Europe/Istanbul"
    },
    "steps": [
      {
        "stepOrder": 1,
        "stepLabel": "page_view",
        "value": 4200
      },
      {
        "stepOrder": 2,
        "stepLabel": "purchase",
        "value": 113
      }
    ]
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-required",
    "message": "tenant-required"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "validation-error",
    "message": "Validation failed for 'timeframe': timeframe must be one of: today, yesterday, last7days, last30days, custom",
    "details": {
      "field": "timeframe",
      "message": "timeframe must be one of: today, yesterday, last7days, last30days, custom"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "bearer-required",
    "message": "bearer-required"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "invalid-credential",
    "message": "invalid-credential"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "credential-revoked",
    "message": "credential-revoked"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "credential-expired",
    "message": "credential-expired"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-not-granted",
    "message": "tenant-not-granted",
    "details": {
      "tenantId": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "source-does-not-belong-to-tenant",
    "message": "source-does-not-belong-to-tenant"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "insufficient-scope",
    "message": "insufficient-scope",
    "details": {
      "required": "reports:read"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-not-found",
    "message": "tenant-not-found",
    "details": {
      "tenantId": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "source-not-found",
    "message": "source-not-found",
    "details": {
      "sourceId": "7b0e5a54-1d43-4c8e-8d2f-5a9c3e6b1f27"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "rate-limited",
    "message": "rate-limited",
    "details": {
      "retryAfterSeconds": 30
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/funnels/preview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

POST

/v1/funnels/preview

POST

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

OAuth access token (token exchange) or organization API key.

query

tenantIdstring

Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

Format: uuid

query

sourceIdstring

UUID of one source of the tenant. Omit it to include every source of the tenant.

Format: uuid

query

timeframestring

Reporting period. The presets today, yesterday, last7days and last30days cover whole calendar days ending today in the request timezone; last7days is today and the six days before it. Use custom together with startDate and endDate. Defaults to the last 30 days.

query

startDatestring

First day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom, together with endDate.

query

endDatestring

Last day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom; it must not be before startDate.

query

timezonestring

IANA time zone name such as Europe/Istanbul or America/New_York. It sets the calendar-day boundaries of the period and of the time buckets. Defaults to Europe/Istanbul.

Min length: 1 • Max length: 100

Content-Typestring

Required

The media type of the request body

Options: application/json

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. OAuth access token (token exchange) or organization API key.

Query Parameters

tenantIdstring

Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

sourceIdstring

UUID of one source of the tenant. Omit it to include every source of the tenant.

timeframestring

startDatestring

First day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom, together with endDate.

endDatestring

Last day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom; it must not be before startDate.

timezonestring

IANA time zone name such as Europe/Istanbul or America/New_York. It sets the calendar-day boundaries of the period and of the time buckets. Defaults to Europe/Istanbul.