Inbound data integrations
Outbound data integrations
Public API documentation
Authentication
Fetch statement reporting data
Copy
Ask AI
curl --request GET \
--url https://api.qobra.co/v1/reporting \
--header 'X-API-Key: <api-key>'Copy
Ask AI
{
"count": 4570,
"data": [
{
"id": "6545110915808dbcc34531ef",
"date": "2023-11-30",
"plan": "Great plan",
"user": {
"id": "5537a5b05d6e4824940e9e1bb9a5ebb8",
"email": "[email protected]",
"name": "John Doe",
"role": "Sales Rep",
"currency": "EUR",
"calculation_currency": "USD",
"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": "[email protected]",
"name": "John Doe",
"role": "Sales Rep",
"currency": "EUR",
"calculation_currency": "USD",
"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"
}Reporting
Fetch statement reporting data
Retrieves statement reporting data. A statement report holds your compensation’s data, consolidated around metrics on a statement level.
GET
/
v1
/
reporting
Fetch statement reporting data
Copy
Ask AI
curl --request GET \
--url https://api.qobra.co/v1/reporting \
--header 'X-API-Key: <api-key>'Copy
Ask AI
{
"count": 4570,
"data": [
{
"id": "6545110915808dbcc34531ef",
"date": "2023-11-30",
"plan": "Great plan",
"user": {
"id": "5537a5b05d6e4824940e9e1bb9a5ebb8",
"email": "[email protected]",
"name": "John Doe",
"role": "Sales Rep",
"currency": "EUR",
"calculation_currency": "USD",
"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": "[email protected]",
"name": "John Doe",
"role": "Sales Rep",
"currency": "EUR",
"calculation_currency": "USD",
"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 usersVariable 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
Query Parameters
Optional (minimum:0 - maximum:9223372036854775807)
Required range:
0 <= x <= 9223372036854776000Optional (minimum:0 - maximum:2000): if set to 0 return total count only
Required range:
0 <= x <= 2000Response
200 - application/json
Success operation
Number of records in the response
Show child attributes
Show child attributes
Id of the record
Amount of the payment
Allowed currency codes.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WST, XAG, XAU, XCD, XPD, XPT, XSU, YER, ZAR, ZMK, ZWL Date
Compensation plan name
Allowed currency codes.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WST, XAG, XAU, XCD, XPD, XPT, XSU, YER, ZAR, ZMK, ZWL Allowed currency codes.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WST, XAG, XAU, XCD, XPD, XPT, XSU, YER, ZAR, ZMK, ZWL Allowed currency codes.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WST, XAG, XAU, XCD, XPD, XPT, XSU, YER, ZAR, ZMK, ZWL Show child attributes
Show child attributes
Id of the user
Email of the user
Name of the user
An enumeration.
Available options:
active, archived, inactive, pending Role of the user
Allowed currency codes.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WST, XAG, XAU, XCD, XPD, XPT, XSU, YER, ZAR, ZMK, ZWL Allowed currency codes.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WST, XAG, XAU, XCD, XPD, XPT, XSU, YER, ZAR, ZMK, ZWL User attribute 1 value
Allowed currency codes.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WST, XAG, XAU, XCD, XPD, XPT, XSU, YER, ZAR, ZMK, ZWL User attribute 2 value
Achievement of the target
Target
Target achievement
On-target earning amount
Next page of the response
Was this page helpful?
⌘I