Skip to content
Sign inBecome a partner
API referenceReports
Documentation

API reference · Partner API

Reports

Aggregated results, per link or per sub-id.

GET/v1/partner-api/reports/links

Clicks, registrations, qualified users and commissions per link, or per link and sub-id, over a period. The last 30 days when no period is given.

AuthPartner API key with scope reports:read

Query parameters

fromstringdate

Start, inclusive: a date (2026-11-01) or an ISO 8601 time.

tostringdate

End, inclusive: a date counts to the end of that day (UTC), or an ISO 8601 time.

groupBystringdefault link

subid: one row per link and sub-id combination.

One of link subid

programIdstringuuid

Only this program.

linkIdstringuuid

Only this link.

currencystring3 chars

Commission currency; defaults to the one you earn most in.

Returns · 200

fromstringrequireddate-time
tostringrequireddate-time
currencystringrequired
groupBystringrequired

One of link subid

columnsarray of objectsrequired
Child attributes
keystringrequired
labelstringrequired
typestringrequired

One of text int money pct date

itemsarray of map of stringsrequired

One row per link, or per link and sub-id; keyed by columns[].key.

truncatedbooleanrequired

True when there were more rows than one report holds.

Errors

400validation_error

The request does not match the schema. details says which fields failed and why.

400invalid_period

to is before from.

401invalid_api_key

No key was sent, or the key is unknown, expired or revoked.

403partner_suspended

API access is suspended for this partner account.

403insufficient_scope

The key lacks the scope this endpoint needs.

429rate_limited

Too many requests with this key in the last minute. Wait Retry-After seconds.

Request
curl "https://api.flowgroup.se/v1/partner-api/reports/links" \
  -H "authorization: Bearer $FA_API_KEY"
200 OK
{
  "from": "2026-11-09T12:00:00.000Z",
  "to": "2026-11-09T12:00:00.000Z",
  "currency": "USD",
  "groupBy": "link",
  "columns": [
    {
      "key": "key",
      "label": "label",
      "type": "text"
    }
  ],
  "items": [
    {
      "key": "value"
    }
  ],
  "truncated": true
}