FunnelFlux Pro API DocumentsFunnelFlux Pro API Documents
  • Changelog
  • Status
  • Dashboard
  • Documentation
  • Authentication
  • Domains
  • Assets
  • Reporting
Information
Authentication
    Access token validationpostRegister a new user (Auth0 provider only)postPassword-based login (legacy)postSend a password reset email (Auth0 provider only)post
Integrations
    List integrationsgetGet integrationgetDelete integrationdeleteRename integrationpatchStart integration OAuthpostComplete integration OAuthgetList integration capabilitiesgetReauthorize integrationpostList integration ad accountsgetList integration conversion goalsgetTrigger integration syncpostList integration sync job statusget
API Keys
    List customer API keysgetCreate a customer API keypostRevoke a customer API keydelete
Schemas
FunnelFlux Authentication API
FunnelFlux Authentication API

Schemas

Download schema

APIKeyCreateRequest

name
​string · required

Label for the key, at most 255 characters after trimming whitespace. Shown in GET /api-keys.

Example: CI deploy

APIKeyIssued

id
​string · required

Key id, used by DELETE /api-keys/{id}.

Example: key_abcdefghijklmnopqrstuv
name
​string · required
created_at
​string · date-time · required
masked
​string · required

Display form of the key, ffk_•••• plus the last four id characters. Safe to show.

Example: ffk_••••stuv
secret
​string · required

The plaintext API key, sent as Authorization: Bearer <secret>. Returned once, only here; only its SHA-256 hash is stored.

Example: ffk_q3JvY2tldFNlY3JldEZvckZ1bm5lbEZsdXhQcm9EdGVzdA

APIKeySummary

id
​string · required
name
​string · required
created_at
​string · date-time · required
masked
​string · required

Display form of the key; the secret is never returned after creation.

APIKeyList

​APIKeySummary[] · required

Active keys, oldest first.

APIKeyError

error
​string · enum · required
Enum values:
invalid_name
not_found
ambiguous_api_key
api_key_limit_reached
issuing_login_unavailable
issuing_login_lookup_failed
api_key_unavailable
error_description
​string

RateLimitError

The API gateway returns this error when the account's per-minute API rate limit is exhausted.
code
​string · enum · required
Enum values:
API_RATE_LIMITED
message
​string · required

IntegrationSyncTriggerRequest

trafficSourceId
​string · required
jobType
​string · enum · required
Enum values:
dictionary_sync
cost_sync
cost_sync_daily
scope
​string · enum
Enum values:
active
Default: active

IntegrationSyncTriggerResult

status
​string · enum
Enum values:
queued
trafficSourceId
​string
jobType
​string · enum
Enum values:
dictionary_sync
cost_sync
cost_sync_daily
scope
​string · enum
Enum values:
active
integrationId
​string
queuedAt
​string · date-time

IntegrationSyncJobStatusResult

​IntegrationSyncJobStatus[]

IntegrationSyncJobStatus

trafficSourceId
​string
jobType
​string · enum
Enum values:
dictionary_sync
cost_sync
cost_sync_daily
integrationId
​string
enabled
​boolean
status
​string
lastStatus
​string
lastError
​string
lastCount
​integer · int32
lastRunAt
​string · date-time
nextRunAt
​string · date-time
intervalSeconds
​integer · int32
running
​boolean
leaseUntil
​string · date-time
updatedAt
​string · date-time

IntegrationConfig

owner
​string
id
​string
name
​string
type
​string
status
​string
​object
​object

Provider-owned connection profile metadata such as Google principal labels.

​object

Masked credentials in public HTTP responses.

connectionState
​string · enum
Enum values:
active
expired
auth_error
disconnected
tokenExpiresAt
​string · date-time
lastValidatedAt
​string · date-time
lastError
​string
createdAt
​string
updatedAt
​string

IntegrationAdAccount

id
​string
name
​string
currency
​string
status
​string
timezone
​string
businessId
​string
businessName
​string

IntegrationConversionGoal

id
​string
resourceName
​string
name
​string
type
​string
status
​string
ownerCustomer
​string
primaryForGoal
​boolean
​object

IntegrationCapabilities

platform
​string
enabled
​boolean

Provider rollout state, derived from the provider capability set (INTEGRATIONS__CAPABILITIES); false when the set is empty or none.

authMethod
​string · enum
Enum values:
oauth
api_key
​object
​object
​object

IntegrationCAPIConfigFieldRequirement

key
​string · required
label
​string · required
required
​boolean · required
scope
​string · enum · required
Enum values:
traffic_source_link
description
​string

IntegrationDictionaryFieldRequirement

level
​string · pattern: ^level[0-9]+$ · required

Provider-neutral ordered machine level, for example level1, level2, or level3. Use label for display text.

label
​string · required
fieldName
​string · required

Exact public traffic-source URL tracking parameter required for this dictionary level. The reserved global campaign slot is addressed as campaign even when displayed as utm_campaign.

urlValue
​string · required

Platform macro/value to place in the tracking URL for this field.

description
​string

EndpointRetiredError

Answer of an account endpoint retired under the Clerk sign-in provider.
error
​string · enum · required
Enum values:
endpoint_retired
error_description
​string · required
replacement
​string · enum · required

Where to go instead. checkout for registration; sign_in for the sign-in page.

Enum values:
sign_in
checkout
On this page
  • APIKeyCreateRequest
  • APIKeyIssued
  • APIKeySummary
  • APIKeyList
  • APIKeyError
  • RateLimitError
  • IntegrationSyncTriggerRequest
  • IntegrationSyncTriggerResult
  • IntegrationSyncJobStatusResult
  • IntegrationSyncJobStatus
  • IntegrationConfig
  • IntegrationAdAccount
  • IntegrationConversionGoal
  • IntegrationCapabilities
  • IntegrationCAPIConfigFieldRequirement
  • IntegrationDictionaryFieldRequirement
  • EndpointRetiredError