GET
/
v1
/
reporting
Fetch statement reporting data
curl --request GET \
  --url https://api.qobra.co/v1/reporting \
  --header 'X-API-Key: <api-key>'
{
  "count": 4570,
  "data": [
    {
      "id": "6545110915808dbcc34531ef",
      "date": "2023-11-30",
      "plan": "Great plan",
      "user": {
        "id": "5537a5b05d6e4824940e9e1bb9a5ebb8",
        "email": "john-doe@company.com",
        "name": "John Doe",
        "role": "Sales Rep",
        "currency": "EUR",
        "country": "France",
        "code": "AO32ND56",
        "...": "..."
      },
      "payment": 0,
      "payment_currency": "USD",
      "target": null,
      "target_currency": "EUR",
      "target_achievement": null,
      "on_target_earning": null,
      "on_target_earning_currency": "EUR",
      "achievement": null,
      "achievement_currency": "EUR",
      "<custom-metric-1-api-key>": 10000,
      "<custom-metric-1-api-key>_currency": "EUR",
      "<custom-dimension-1-api-key>": [
        "group_1",
        "group_2"
      ]
    },
    {
      "id": "6545110915808dbcc34531ee",
      "date": "2023-11-30",
      "plan": "Manual payments",
      "user": {
        "id": "5537a5b05d6e4824940e9e1bb9a5ebb8",
        "email": "john-doe@company.com",
        "name": "John Doe",
        "role": "Sales Rep",
        "currency": "EUR",
        "country": "France",
        "code": "AO32ND56",
        "...": "..."
      },
      "payment": 0,
      "payment_currency": "USD",
      "target": null,
      "target_currency": "EUR",
      "target_achievement": null,
      "on_target_earning": null,
      "on_target_earning_currency": "EUR",
      "achievement": null,
      "achievement_currency": "EUR",
      "<custom-metric-1-api-key>": 10000,
      "<custom-metric-1-api-key>_currency": "EUR",
      "<custom-dimension-1-api-key>": [
        "group_1",
        "group_2"
      ]
    },
    "..."
  ],
  "next": "https://api.qobra.co/v1/reporting?limit=2000&offset=2000"
}

​
Pagination

This endpoint is paginated using parameters offset and limit The “next” key in the response allow you to easily follow pagination to get the next batch of users

​
Variable api keys

This endpoint is based on dynamic fields. This mean that all annotations that look like <variable-key>, will have to or will be replaced by their actual API keys.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
offset
integer
default:0

Optional (minimum:0 - maximum:9223372036854775807)

Required range: 0 <= x <= 9223372036854776000
​
limit
integer
default:2000

Optional (minimum:0 - maximum:2000): if set to 0 return total count only

Required range: 0 <= x <= 2000

Response

200 - application/json

Success operation

The response is of type object.