Skip to content
Browse documentation

OpenAPI operations

Read the site-wide activation funnel summary

GET
/v1/funnel/summary
curl --request GET \
  --url https://api.hooks.events/v1/funnel/summary \
  --header 'Authorization: Bearer <token>'

Platform-admin-only site-wide activation funnel (#609, #683): stage counts against the try_started cohort, time to first success, continued use, and first-touch source breakdown across every visitor and workspace. days (1-365, default 30) bounds the cohort window. Non-admins, including workspace owners, receive 403.

Requires the session scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
days
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
required

Site-wide activation funnel summary for platform admins (#683)

object
windowDays
required
integer
>= -9007199254740991 <= 9007199254740991
cohortVisitors
required
integer
>= -9007199254740991 <= 9007199254740991
stages
required
Array<object>
object
stage
required

Funnel stage from the event dictionary

string
count
required

Distinct subjects that reached the stage (real traffic only)

integer
>= -9007199254740991 <= 9007199254740991
denominator
required

Cohort size: visitors whose try_started is in the window

integer
>= -9007199254740991 <= 9007199254740991
rate
required

Count / denominator, 0..1

number
testModeCount
required

Demo/test occurrences recorded but excluded from count

integer
>= -9007199254740991 <= 9007199254740991
key
additional properties
timeToFirstSuccess
required

Event_received to delivery_succeeded per workspace

object
samples
required
integer
>= -9007199254740991 <= 9007199254740991
medianMs
required
number | null
p95Ms
required
number | null
key
additional properties
continuedUse
required
object
projects
required
integer
>= -9007199254740991 <= 9007199254740991
activeProjects
required
integer
>= -9007199254740991 <= 9007199254740991
definition
required
string
key
additional properties
sources
required
Array<object>
object
source
required

First-touch utm_source, referrer host, or ‘direct’

string
category
required
string
Allowed values: ai_referral search direct other
visitors
required
integer
>= -9007199254740991 <= 9007199254740991
signups
required
integer
>= -9007199254740991 <= 9007199254740991
activated
required

Visitors whose workspace received a real event

integer
>= -9007199254740991 <= 9007199254740991
key
additional properties
linkedVisitor
required

True when the caller has a signup-linked visitor

boolean
key
additional properties
key
additional properties

Example 

{
  "data": {
    "sources": [
      {
        "category": "ai_referral"
      }
    ]
  }
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

401

Section titled “401”

Missing or invalid credentials

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

403

Section titled “403”

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

429

Section titled “429”

Rate limited

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

Requests allowed per window

X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer

Seconds until the window resets

Retry-After
integer

Seconds to wait before retrying. Absent when the rejection has no retry time (for example the Free lifetime quota).

X-Quota-Limit
integer

Request allowance for the workspace’s plan

X-Quota-Remaining
integer

Requests left in the allowance after this request