Skip to main content
POST
/
networks
/
reporting
/
referrals
Get Referral Report
curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/referrals \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "from": "<string>",
  "to": "<string>",
  "timezone_id": 123,
  "currency_id": "<string>",
  "query": {
    "filters": {
      "referring_affiliate_ids": [
        123
      ]
    }
  }
}
'
{
  "referrals": [
    {
      "referring_affiliate": {},
      "referred_affiliate": {},
      "revenue": 123,
      "conversions": 123
    }
  ]
}

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Body

application/json
from
string
required

Start date (format: YYYY-MM-DD).

to
string
required

End date (format: YYYY-MM-DD).

timezone_id
integer
required

Timezone ID for the report.

currency_id
string
required

Currency code for reporting metrics.

query
object

Optional filters including referring_affiliate_ids.

Response

200 - application/json

OK

referrals
object[]