FunnelFlux Pro API DocumentsFunnelFlux Pro API Documents
  • Changelog
  • Status
  • Dashboard
  • Documentation
  • Authentication
  • Domains
  • Assets
  • Reporting
Information
Traffic Sources
    List traffic sourcesgetFind traffic source by IDgetFind traffic sources by ID listgetFind traffic sources by statusgetFind traffic sources by categorygetSave traffic sourceputCreate traffic sourcepostDuplicate traffic sourcepostDelete traffic sourcedeleteArchive traffic sourcesputUnarchive traffic sourcesputMove traffic sources to a categoryput
Data Mapping
    Upload manual name mappings for a traffic source fieldputClear manual name mappings of a traffic sourcepost
Offer Sources
    List offer sourcesgetFind offer source by IDgetFind offer sources by ID listgetFind offer sources by statusgetFind offer sources by categorygetSave offer sourceputCreate offer sourcepostDuplicate offer sourcepostDelete offer sourcedeleteArchive offer sourcesputUnarchive offer sourcesputMove offer sources to a categoryput
Funnel Groups
    List funnel groupsgetFind funnel group by IDgetFind funnel groups by ID listgetFind funnel groups by statusgetUpdate a funnel groupputCreate a funnel grouppostDuplicate a funnel grouppostDelete a funnel groupdeleteArchive funnel groupsputList funnel groupsgetFind funnel group by IDgetFind funnel groups by ID listgetFind funnel groups by statusgetUpdate an existing funnel groupputCreate a new funnel grouppostDuplicate a funnel grouppostDelete a funnel groupdeleteArchive funnel groupsputUnarchive funnel groupsput
Funnels
    List funnelsgetFind funnel by IDgetFind funnels by ID listgetFind funnels by statusgetFind funnels by typegetFind funnels by categorygetUpdate a funnelputCreate a funnelpostDuplicate a funnelpostDelete a funneldeleteArchive a funnelputUnarchive a funnelputMove a funnelputMove funnels into a funnel groupput
Conditions
    List conditionsgetFind condition by IDgetFind conditions by ID listgetFind conditions by statusgetFind conditions by categorygetUpdate a conditionputCreate a conditionpostDuplicate a conditionpostDelete a conditiondeleteArchive conditionsputUnarchive conditionsputMove conditions to a categoryput
Logic Scripts
    List logic scriptsgetFind logic script by IDgetFind logic scripts by ID listgetFind logic scripts by namegetFind logic scripts by statusgetFind logic scripts by categorygetUpdate a logic scriptputCreate a logic scriptpostDuplicate a logic scriptpostSoft-delete logic scriptsdeleteGet logic script language metadatagetValidate logic script codepostArchive logic scriptsputUnarchive logic scriptsputMove logic scripts to a categoryput
Visitor Tags
    Find visitor tag by IDgetList visitor tagsgetFind visitor tags by statusgetUpdate a visitor tagputCreate a visitor tagpostDuplicate a visitor tagpostDelete visitor tagsdeleteArchive visitor tagsputUnarchive visitor tagsputMove visitor tags to categoryput
Short Links
    List saved short linksgetFind saved short link by IDgetFind saved short link by sluggetUpdate a saved short linkputCreate a saved short linkpostDelete saved short linksdeleteDuplicate a saved short linkpostArchive saved short linksputUnarchive saved short linksput
Page Groups
    List page groupsgetFind a page group by IDgetFind page groups by ID listgetFind page groups by statusgetFind page groups by typegetFind page groups by categorygetUpdate a page groupputCreate a page grouppostDuplicate a page grouppostDelete a page groupdeleteArchive page groupsputUnarchive page groupsputMove global page groups to a categoryputFind page groups by categorygetMove global page groups to a categoryput
Pages
    List pagesgetFind a page by IDgetFind pages by ID listgetFind pages by statusgetFind pages by categorygetUpdate a pageputCreate a new pagepostDuplicate a pagepostDelete a pagedeleteArchive pagesputUnarchive pagesputMove pages to a categoryput
Categories
    List categoriesgetFind category by IDgetFind categories by ID listgetUpdate a categoryputCreate a categorypostDuplicate a categorypostDelete a categorydeleteArchive categoriesputUnarchive categoriesput
User
    Get user settingsgetSave user settingsputDelete user settingsdelete
Integration
    List integration API keysgetUpdate integration API keyputGenerate integration API keypostDelete integration API keydelete
AI Node Settings
    Update AI node settingsputCreate AI node settingspostFind AI node settings by IDgetFind AI node settings by ID listgetDelete AI node settingsdelete
Webhook Configs
    List webhook configsgetFind webhook config by IDgetFind webhook configs by ID listgetSave webhook configputCreate webhook configpostDelete webhook configdeleteDuplicate webhook configpostArchive webhook configsputUnarchive webhook configsputMove webhook configs to categoryput
Middleware Configs
    List middleware configsgetFind middleware config by IDgetFind middleware configs by ID listgetSave middleware configputCreate middleware configpostDelete middleware configdeleteDuplicate middleware configpostArchive middleware configsputUnarchive middleware configsputMove middleware configs to categoryput
Schemas
FunnelFlux Assets API
FunnelFlux Assets API

Data Mapping

Download schema

Upload and clear the traffic-source names that show in Reporting. Written through this Ledger (Assets) API, not the Reporting API.


Upload manual name mappings for a traffic source field

PUT
https://api.funnelflux.pro/v1
/trafficsource/data-mapping/upload/

Merges ID-to-name rows into the traffic source's manual names for one field (campaign, field1 or field2). A row whose ID already has a manual name replaces it; every other stored name is kept. The field must be declared in the traffic source's dataMapping, and the traffic source must not get its names from dictionary sync.

Limits: at most 10,000 rows per request and a request body of at most 4 MiB (4,194,304 bytes). Larger uploads must be split. A body over 4 MiB sent through the API gateway is refused by the gateway itself with a plain-text HTTP 400 ("Error when parsing request"), not the JSON error below.

Each ID and name is trimmed of surrounding whitespace, must then be 1 to 512 characters, and must not contain control or format characters. IDs are compared without regard to letter case: rows with the same ID and the same name collapse into one, rows with the same ID and different names are all refused as duplicate_id_conflict. The upload is all-or-nothing for row validation: if any row is refused, nothing is stored and the response lists every refused row in rowErrors.

Checks run in this order and the first to fail answers: body size (413), request shape (400 invalid_request), traffic source exists and is not deleted (404), dictionary sync is off (409 dictionary_sync_enabled), field is declared (409 field_not_declared), row count (400 no_rows / too_many_rows), row contents (400 invalid_rows).

Upload manual name mappings for a traffic source field › Request Body

DataMappingUploadRequest
idTrafficSource
​string · required
field
​string · enum · required
Enum values:
campaign
field1
field2
​DataMappingRow[] · minItems: 1 · maxItems: 10000 · required

Rows to merge. rowErrors[].row in an error response is the 1-based position in this array.

Upload manual name mappings for a traffic source field › Responses

Rows merged

DataMappingUploadResponse
idTrafficSource
​string · required
field
​string · enum · required
Enum values:
campaign
field1
field2
added
​integer · required

Rows whose ID had no manual name before.

updated
​integer · required

Rows whose ID already had a manual name, which was replaced.

PUT/trafficsource/data-mapping/upload/
curl --request PUT \ --url https://api.funnelflux.pro/v1/trafficsource/data-mapping/upload \ --header 'Content-Type: application/json' \ --data ' { "idTrafficSource": "idTrafficSource", "field": "campaign", "rows": [ { "id": "id", "name": "name" } ] } '
Example Request Body
{ "idTrafficSource": "idTrafficSource", "field": "campaign", "rows": [ { "id": "id", "name": "name" } ] }
json
Example Responses
{ "idTrafficSource": "idTrafficSource", "field": "campaign", "added": 0, "updated": 0 }
json
application/json

Clear manual name mappings of a traffic source

POST
https://api.funnelflux.pro/v1
/trafficsource/data-mapping/clear/

Removes manual names of one traffic source. With field, only that field's manual names are removed. Without field (or with field empty), every manual name of that traffic source is removed, across campaign, field1 and field2, declared or not. A clear never reaches more than one traffic source: other traffic sources of the account and other accounts' names are untouched. Names synced from an integration are never touched. The field does not need to be declared, so names left behind by an undeclared field can be removed. Clearing a field, or a source, with no stored names succeeds with removed 0. A field outside campaign/field1/field2 is refused with 400 invalid_request and nothing is cleared. Because an omitted field clears all fields, the body may hold only idTrafficSource and field, spelled exactly so and each at most once: any other key (such as a misspelled feild or Field in another letter case), a repeated key, and an explicit "field": null are refused with 400 invalid_request and nothing is cleared.

Returns 404 for a missing or deleted traffic source and 409 dictionary_sync_enabled when the traffic source gets its names from dictionary sync.

Clear manual name mappings of a traffic source › Request Body

DataMappingClearRequest
idTrafficSource
​string · required
field
​string · enum

Field to clear. Omit it, or send it empty, to clear every manual name of that one traffic source: campaign, field1 and field2, declared or not. A clear never reaches another traffic source, another account, or names synced from an integration. null is refused with 400; omit the key instead.

Enum values:
campaign
field1
field2

Clear manual name mappings of a traffic source › Responses

Names removed

DataMappingClearResponse
idTrafficSource
​string · required
removed
​integer · int64 · required

Number of manual names removed.

POST/trafficsource/data-mapping/clear/
curl --request POST \ --url https://api.funnelflux.pro/v1/trafficsource/data-mapping/clear \ --header 'Content-Type: application/json' \ --data ' { "idTrafficSource": "idTrafficSource", "field": "campaign" } '
Example Request Body
{ "idTrafficSource": "idTrafficSource", "field": "campaign" }
json
Example Responses
{ "idTrafficSource": "idTrafficSource", "removed": 0 }
json
application/json

Traffic SourcesOffer Sources