FunnelFlux Pro API DocumentsFunnelFlux Pro API Documents
  • Changelog
  • Status
  • Dashboard
  • Documentation
  • Authentication
  • Domains
  • Assets
  • Reporting
Information
Reporting
    List available attributesgetCreate a drilldown reportpostCreate a raw event reportpost
Updates
    Submit a conversion updateputSubmit a custom event updateputSubmit a cost updateputValidate a data resetpostPerform a data resetdelete
Logs
    Get postback logpostGet webhook asset summarypostGet middleware asset summarypostGet incoming postback logspostGet integration logspostGet integration queue rowspostGet postback logpost
Explorer
    Look up a visitorpostLook up a single hitpost
Schemas
FunnelFlux Reporting API
FunnelFlux Reporting API

Updates

Download schema

Conversion, cost, and reset update endpoints


Submit a conversion update

PUT
https://api.funnelflux.pro/v1
/reporting/update/conversions/

Add new conversions or correct existing ones on explicit hit IDs. Updates are queued and processed asynchronously.

A conversion is identified by its hit ID and transaction ID. When the hit already has a conversion with the same transaction ID, the result depends on the time since the previous accepted conversion for that pair. The time is measured between the two conversion times; a hit without conversionTime uses the time FunnelFlux receives the request.

  • Up to 5 minutes: the upload is ignored as a duplicate, whatever its revenue, unless the revenue is negative. Nothing is sent.
  • More than 5 minutes, up to 3 hours (the correction window): an upload with the same revenue is ignored. An upload with different revenue replaces the revenue and keeps the original conversion time. Traffic source postback URLs and webhooks are not called again unless forcePostbacks is true. Traffic source integrations receive an adjustment: Google Ads applies it; Meta, TikTok, and Microsoft Ads do not support adjustments, so nothing is sent to them.
  • More than 3 hours: the upload replaces the existing conversion, keeps the original conversion time, and is delivered again to postback URLs, webhooks, and integrations. Set disablePostbacks to true when a correction must not reach the traffic source again.

A negative revenue deletes the existing conversion at any time, including within 5 minutes of the previous upload. Google Ads receives a retraction; postback URLs and webhooks are called only when forcePostbacks is true. Meta, TikTok, and Microsoft Ads support neither adjustments nor retractions, so a deletion sends nothing to them.

disablePostbacks, or postbackCalls set to none, stops all outbound delivery for the request and takes precedence over forcePostbacks. Reporting is updated either way.

Submit a conversion update › Request Body

ConversionsUpdateParams
​ConvertedHit[] · required
postbackCalls
​string · enum

Set to 'none' to stop all outbound delivery for this request, the same as disablePostbacks: true. When omitted, delivery is not stopped: postbacks follow disablePostbacks, forcePostbacks and the re-upload rules in the endpoint description. 'onlyOnce' and 'all' are accepted for compatibility but behave the same as an omitted value. In particular, 'onlyOnce' does not stop a re-upload from being delivered again; use 'none' or disablePostbacks to prevent it.

Enum values:
none
onlyOnce
all
overridePayout
​NullableDecimal
Default: null
disablePostbacks
​boolean

When true, FunnelFlux records the conversions but sends nothing to traffic source postback URLs, webhooks, or integrations for this request. Takes precedence over forcePostbacks. Use it for corrections that the traffic source must not receive again.

Default: false
forcePostbacks
​boolean

When true, postback URLs and webhooks are also called for revenue corrections inside the correction window described for the endpoint, and for negative-revenue deletions at any time; neither is sent there otherwise. It does not resend an upload ignored as a duplicate and does not change what integrations receive. Ignored when disablePostbacks is true or postbackCalls is 'none'.

Default: false

Submit a conversion update › Responses

Update queued for processing

No data returned
PUT/reporting/update/conversions/
curl --request PUT \ --url https://api.funnelflux.pro/v1/reporting/update/conversions \ --header 'Content-Type: application/json' \ --data '{}'
Example Request Body
{}
json
Example Responses
No example specified for this content type

Submit a custom event update

PUT
https://api.funnelflux.pro/v1
/reporting/update/customevents/

Add custom events 1-10 from explicit hit IDs. The full batch is rejected on validation errors; invalid rows are not skipped. Updates are queued and processed asynchronously.

Custom events are not deduplicated by the conversion time windows. Each accepted upload is processed as a new custom event and is sent to traffic source postback URLs, webhooks, Meta, and TikTok, including when the same event was uploaded before. Google Ads and Microsoft Ads receive a custom event only once per hit and event number; a later upload of the same event is not sent to them again. Set disablePostbacks to true, or postbackCalls to none, to record the events without sending them. Negative revenue is rejected, so a custom event cannot be corrected or deleted by uploading it again.

Submit a custom event update › Request Body

CustomEventsUpdateParams
​CustomEventUploadHit[] · minItems: 1 · maxItems: 10 · required
postbackCalls
​string · enum

Set to 'none' to stop all outbound delivery for this request, the same as disablePostbacks: true. When omitted, delivery is not stopped and follows disablePostbacks. Other values behave the same as an omitted value; custom events have no force option.

Enum values:
none
onlyOnce
all
disablePostbacks
​boolean

When true, FunnelFlux records the custom events but sends nothing to traffic source postback URLs, webhooks, or integrations for this request.

Default: false

Submit a custom event update › Responses

Update queued for processing

No data returned
PUT/reporting/update/customevents/
curl --request PUT \ --url https://api.funnelflux.pro/v1/reporting/update/customevents \ --header 'Content-Type: application/json' \ --data '{}'
Example Request Body
{}
json
Example Responses
No example specified for this content type

Submit a cost update

PUT
https://api.funnelflux.pro/v1
/reporting/update/cost/

Update the cost of specific traffic segments over an inclusive window. Both times are required and nonzero; timeEnd must be strictly after timeStart. timeStart must be on or after 2020-01-01T00:00:00Z; timeEnd must not exceed timeStart's UTC 12-calendar-month anniversary (the 1-year data period). Exact limits are accepted.

Submit a cost update › Request Body

CostUpdateParams
funnelIDs
​string[] · required
Default: []
trafficSourceIDs
​string[] · required
Default: []
timeStart
​string · date-time · required

Required nonzero inclusive start, on or after 2020-01-01T00:00:00Z. UTC instants are compared; offsets are accepted. No future-date restriction.

timeEnd
​string · date-time · required

Required nonzero inclusive end, strictly after timeStart and no later than timeStart.UTC().AddDate(0, 12, 0). This is 12 calendar months (1-year data period), not 365 days; February 29 normalizes to March 1 in a non-leap year. Exact anniversary is accepted.

​CostSegment[] · required
includeFilteredTraffic
​boolean

Include filtered entrances when assigning cost. Defaults to false; excluded entrances are left out of the update and keep their existing cost.

Default: false
includeProxyHostingTraffic
​boolean

Include Known Proxy and Hosting Provider entrances when assigning cost. Defaults to false; excluded entrances are left out of the update and keep their existing cost.

Default: false

Submit a cost update › Responses

Cost updates accepted for asynchronous processing. Matching segments are queued; zero-entrance segments complete as no-ops. Warehouse application completes later and is not part of this response.

No data returned
PUT/reporting/update/cost/
curl --request PUT \ --url https://api.funnelflux.pro/v1/reporting/update/cost \ --header 'Content-Type: application/json' \ --data '{}'
Example Request Body
{}
json
Example Responses
No example specified for this content type

Validate a data reset

POST
https://api.funnelflux.pro/v1
/reporting/update/reset/

Count hits matching the reset settings and inclusive window. Both times must be nonzero, timeEnd strictly after timeStart, timeStart on or after 2020-01-01T00:00:00Z, and timeEnd at most the UTC 12-calendar-month anniversary (1-year data period). Exact limits are accepted. At least one non-blank restriction besides time is required, and blank restrictToFunnelIDs entries are rejected. Scope is checked before the window, before counting.

Validate a data reset › Request Body

Estimate or execute a reset with at least one non-blank restriction beyond its bounded time window. Scope validation precedes time-window validation; execute inherits the same checks as estimate.
ResetUpdateParams
timeStart
​string · date-time · required

Required nonzero inclusive start, on or after 2020-01-01T00:00:00Z. UTC instants are compared; offsets are accepted. No future-date restriction.

timeEnd
​string · date-time · required

Required nonzero inclusive end, strictly after timeStart and no later than timeStart.UTC().AddDate(0, 12, 0). This is 12 calendar months (1-year data period), not 365 days; February 29 normalizes to March 1 in a non-leap year. Exact anniversary is accepted.

restrictToCampaignIDs
​string[]
Default: []
restrictToFunnelIDs
​string[]
Default: []
restrictToTrafficSourceIDs
​string[]
Default: []
restrictToCountryCodes
​string[]
Default: []
restrictToVisitorIDs
​string[]
Default: []
restrictToIPs
​string[]
Default: []
​object

If set, then reset only traffic that has these tracking fields' keys/values. Keys are case-insensitive and must be campaign, external, or a tracking field slot 1-20 written as cN, tN, trackingfieldN, or tracking_field_N; any other key is rejected with 400. A key with an empty value list or only blank values is rejected with 400; omit the key to leave tracking fields unrestricted.

Validate a data reset › Responses

The number of would-be impacted hits

IntegerValue
value
​integer · int64 · required
POST/reporting/update/reset/
curl --request POST \ --url https://api.funnelflux.pro/v1/reporting/update/reset \ --header 'Content-Type: application/json' \ --data '{}'
Example Request Body
{}
json
Example Responses
{ "value": 0 }
json
application/json

Perform a data reset

DELETE
https://api.funnelflux.pro/v1
/reporting/update/reset/

Reset stats of specific traffic segments over an inclusive window. Both times must be nonzero, timeEnd strictly after timeStart, timeStart on or after 2020-01-01T00:00:00Z, and timeEnd at most the UTC 12-calendar-month anniversary (1-year data period). Exact limits are accepted. At least one non-blank restriction besides time is required, and blank restrictToFunnelIDs entries are rejected. Scope is checked before the window; invalid requests reach neither counting nor deletion.

Perform a data reset › Request Body

Estimate or execute a reset with at least one non-blank restriction beyond its bounded time window. Scope validation precedes time-window validation; execute inherits the same checks as estimate.
ResetUpdateParams
timeStart
​string · date-time · required

Required nonzero inclusive start, on or after 2020-01-01T00:00:00Z. UTC instants are compared; offsets are accepted. No future-date restriction.

timeEnd
​string · date-time · required

Required nonzero inclusive end, strictly after timeStart and no later than timeStart.UTC().AddDate(0, 12, 0). This is 12 calendar months (1-year data period), not 365 days; February 29 normalizes to March 1 in a non-leap year. Exact anniversary is accepted.

restrictToCampaignIDs
​string[]
Default: []
restrictToFunnelIDs
​string[]
Default: []
restrictToTrafficSourceIDs
​string[]
Default: []
restrictToCountryCodes
​string[]
Default: []
restrictToVisitorIDs
​string[]
Default: []
restrictToIPs
​string[]
Default: []
​object

If set, then reset only traffic that has these tracking fields' keys/values. Keys are case-insensitive and must be campaign, external, or a tracking field slot 1-20 written as cN, tN, trackingfieldN, or tracking_field_N; any other key is rejected with 400. A key with an empty value list or only blank values is rejected with 400; omit the key to leave tracking fields unrestricted.

Perform a data reset › Responses

Reset queued for processing

No data returned
DELETE/reporting/update/reset/
curl --request DELETE \ --url https://api.funnelflux.pro/v1/reporting/update/reset \ --header 'Content-Type: application/json' \ --data '{}'
Example Request Body
{}
json
Example Responses
No example specified for this content type

ReportingLogs