Conversion Updates
While conversions are mostly immutable in Everflow, there are a few properties that can be updated. They are :
- The status of the conversion (approved, rejected, etc.)
- The payout and revenue associated with a conversion
- The sale amount associated with a conversion
All other properties (query parameters like adv1
, adv2
, etc.) cannot be modified after the creation of the conversion.
Note that updating the conversion will create an entry in the conversion history.
Update Conversion Status
/v1/networks/reporting/conversions
This endpoint allows you to modify the status of multiple conversions at the same time.
There are 4 possible status to Everflow conversions :
approved
rejected
pending
invalid
but a conversion cannot be updated to the pending
or invalid
status. Only approved
and rejected
are accepted values on this endpoint.
Note that the endpoint is asynchronous. Even when the endpoint returns true
immediately, it may take up to a few seconds for the conversion updates to be processed (and to fire partner pixels if appropriate). Though this is a rare occurence, the endpoint may return true
even if the update ultimately fails when it is processed.
Request Body
Body Param
Conversion IDs of the conversions to be updated.
New status of the conversion. Must be approved
or rejected
Body Example
{
"conversion_ids": [
"baab7e25bba046e6b080c799729c5cba",
"a91a421038ab46b694547f4db636db80",
"ca62c52cc745486bbf438f96fc24d6a8"
],
"conversion_status": "rejected"
}
Request Examples
cURL
curl --request PATCH 'https://api.eflow.team/v1/networks/reporting/conversions' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'
Example : Setting a single conversion as rejected
{
"conversion_ids": [
"9e6e4d8389f04c42825d81fee6360297"
],
"conversion_status": "approved"
}
Response
{
"result": true
}
Update Conversion Status by Transaction ID
/v1/networks/reporting/conversions/:transactionId
This endpoint allows you to modify the status of all conversions / events linked to a single transaction ID.
There are 4 possible status to Everflow conversions :
approved
rejected
pending
invalid
but a conversion cannot be updated to the pending
or invalid
status. Only approved
and rejected
are accepted values on this endpoint.
Note that the endpoint is asynchronous. Even when the endpoint returns true
immediately, it may take up to a few seconds for the conversion updates to be processed (and to fire partner pixels if appropriate). Though this is a rare occurence, the endpoint may return true
even if the update ultimately fails when it is processed.
Conversions that are invalid
will be ignored on this endpoint. Only approved
, rejected
and pending
conversions will be updated.
Request Body
Body Param
New status of the conversion. Must be approved
or rejected
Body Example
{
"conversion_status": "rejected"
}
Request Examples
cURL
curl --request PATCH 'https://api.eflow.team/v1/networks/reporting/conversions/9e6e4d8389f04c42825d81fee6360297' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'
Example : Setting all the conversions linked to a transaction ID as approved
{
"conversion_status": "approved"
}
Response
{
"result": true
}
Update Conversion Payout and Revenue
/v1/networks/reporting/conversions/:conversionId/payoutrevenue
This endpoint allows you to update the payout and revenue amounts associated with a conversion. Note that only approved
conversions (or throttled conversions) can be updated through this endpoint.
Note that these amounts be only be absolute values. Even if the offer is setup as RPS
with 20%
revenue for example, it cannot be updated to 25%
revenue - it must be updated to e.g. 5.75
.
This endpoint also doesn’t take a currency. The currency of the offer will be used.
Note that the endpoint is asynchronous. Even when the endpoint returns true
immediately, it may take up to a few seconds for the conversion update to be processed.
Path Parameters
Parameter | Description |
---|---|
conversionId | The ID of the conversion that must be updated |
Body Params
The amount of the partner payout.
The amount of the revenue.
Request Examples
cURL
curl --request PUT 'https://api.eflow.team/v1/networks/reporting/conversions/9e6e4d8389f04c42825d81fee6360297/payoutrevenue' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
"payout": 4.25,
"revenue": 5
}'
Response
{
"result": true
}
Update Conversion Sale Amount
/v1/networks/reporting/conversions/:conversionId/saleamount
This endpoint allows you to update the sale amount associated with a conversion.
Note that this using this endpoint will never affect the value of the payout and revenue amounts. Even in a case where an offer is setup as CPS / RPS, update the sale amount still will not change the payout and revenue.
This endpoint also doesn’t take a currency. The currency of the offer will be used.
Note that the endpoint is asynchronous. Even when the endpoint returns true
immediately, it may take up to a few seconds for the conversion update to be processed.
Path Parameters
Parameter | Description |
---|---|
conversionId | The ID of the conversion that must be updated |
Body Params
The new sale amount associated with the conversion.
Request Examples
cURL
curl --request PUT 'https://api.eflow.team/v1/networks/reporting/conversions/9e6e4d8389f04c42825d81fee6360297/saleamount' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
"sale_amount" : 199.99
}'
Response
{
"result": true
}
Update On Hold Conversion Status
/v1/networks/reporting/onhold
This endpoint allows you to modify the status of multiple on hold conversions at the same time.
There are 3 possible status to Everflow on hold conversions :
approved
rejected
on_hold
but an on hold conversion cannot be updated to the on_hold
status. Only approved
and rejected
are accepted values on this endpoint. An on hold conversion that has already been approved cannot be updated to rejected
.
Note that the endpoint is asynchronous. Even when the endpoint returns true
immediately, it may take up to a few seconds for the on hold conversion updates to be processed (and to create actual conversions if appropriate). Though this is a rare occurence, the endpoint may return true
even if the update ultimately fails when it is processed.
Request Body
Body Param
On hold conversion IDs of the on hold conversions to be updated.
New status of the on hold conversion. Must be approved
or rejected
.
Body Example
{
"on_hold_conversion_ids": [
"baab7e25bba046e6b080c799729c5cba",
"a91a421038ab46b694547f4db636db80",
"ca62c52cc745486bbf438f96fc24d6a8"
],
"status": "approved"
}
Request Examples
cURL
curl --request PATCH 'https://api.eflow.team/v1/networks/reporting/onhold' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'
Example : Setting a single on hold conversion as rejected
{
"on_hold_conversion_ids": [
"9e6e4d8389f04c42825d81fee6360297"
],
"status": "rejected"
}
Response
{
"result": true
}