Fetch record reporting data

GET

reporting

{data_table_key}

records

curl --request GET \
  --url https://api.qobra.co/v1/reporting/{data_table_key}/records \
  --header 'X-API-Key: <api-key>'

{
  "count": 457,
  "data": [
    {
      "id": "6545110915808dbcc34531ee",
      "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",
        "...": "..."
      },
      "record": {
        "id": "6545110915808eecc34531ee",
        "name": "Great opportunity",
        "amount": 55000,
        "amount_currency": "EUR",
        "status": "Closed won",
        "owner": "user@company.com",
        "<custom-dimension-1-api-key>": [
          "group_1",
          "group_2"
        ],
        "...": "..."
      },
      "commission": 3500,
      "commission_currency": "EUR"
    },
    "..."
  ],
  "next": "https://api.qobra.co/v1/reporting/opportunity/records?limit=200&offset=200"
}

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

Path Parameters

data_table_key

string

required

Used to identify the data table

Query Parameters

offset

integer

default:0

Optional (minimum:0 - maximum:9223372036854775807)

Required range: 0 <= x <= 9223372036854776000

limit

integer

default:200

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

Required range: 0 <= x <= 200

Response

200 - application/json

Success operation

count

integer

required

Number of records in the response

data

object[]

required

data.id

string

required

Id of the record

data.date

string

required

Date

data.plan

string

required

Compensation plan name

data.<record-metric-1-api-key>

string

required

data.<record-metric-2-api-key>

string

required

data.user

object

required

data.user.id

string

required

Id of the user

data.user.email

string

required

Email of the user

data.user.name

string

required

Name of the user

data.user.status

enum<string>

required

An enumeration.

Available options:

active,

archived,

inactive,

pending

data.user.role

string

required

Role of the user

data.user.currency

enum<string>

required

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

data.user.<user-attribute-1-api-key>

string

User attribute 1 value

data.user.<user-attribute-1-api-key>_currency

enum<string>

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

data.user.<user-attribute-2-api-key>

string

User attribute 2 value

data.user.{key}

data.record

object

required

string

Next page of the response

Was this page helpful?

Raise issue

Fetch statement reporting data SSO

curl --request GET \
  --url https://api.qobra.co/v1/reporting/{data_table_key}/records \
  --header 'X-API-Key: <api-key>'

{
  "count": 457,
  "data": [
    {
      "id": "6545110915808dbcc34531ee",
      "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",
        "...": "..."
      },
      "record": {
        "id": "6545110915808eecc34531ee",
        "name": "Great opportunity",
        "amount": 55000,
        "amount_currency": "EUR",
        "status": "Closed won",
        "owner": "user@company.com",
        "<custom-dimension-1-api-key>": [
          "group_1",
          "group_2"
        ],
        "...": "..."
      },
      "commission": 3500,
      "commission_currency": "EUR"
    },
    "..."
  ],
  "next": "https://api.qobra.co/v1/reporting/opportunity/records?limit=200&offset=200"
}

Inbound data integrations

Outbound data integrations

Public API documentation

Authentication

Variable api keys

Authorizations

Path Parameters

Query Parameters

Response

Inbound data integrations

Outbound data integrations

Public API documentation

Authentication

​Pagination

​Variable api keys

Authorizations

Path Parameters

Query Parameters

Response

Pagination

Variable api keys