FunnelFlux Pro API DocumentsFunnelFlux Pro API Documents
  • Changelog
  • Status
  • Dashboard
  • Documentation
  • Authentication
  • Domains
  • Assets
  • Reporting
Information
Authentication
    Access token validationpostPassword-based login (legacy)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
Schemas
FunnelFlux Authentication API
FunnelFlux Authentication API

Schemas

Download schema

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

IntegrationConversionGoal

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

IntegrationCapabilities

platform
​string
enabled
​boolean

Provider rollout state. Missing should be treated as enabled by backward-compatible clients.

Default: true
disabledReason
​string
authMethod
​string · enum
Enum values:
oauth
api_key
​object
​object
​object

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
On this page
  • IntegrationSyncTriggerRequest
  • IntegrationSyncTriggerResult
  • IntegrationSyncJobStatusResult
  • IntegrationSyncJobStatus
  • IntegrationConfig
  • IntegrationAdAccount
  • IntegrationConversionGoal
  • IntegrationCapabilities
  • IntegrationDictionaryFieldRequirement