Data-quality findings of the MRR calculation

curl --request GET \
  --url https://coreapi.io/api/analytics/mrr-financials/findings \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://coreapi.io/api/analytics/mrr-financials/findings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/api/analytics/mrr-financials/findings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "<string>",
      "code": "PRICE_HISTORY_UNKNOWN",
      "codeLabel": "Preisverlauf unbekannt",
      "severity": "error",
      "message": "<string>",
      "entityType": "<string>",
      "entityId": "<string>",
      "monthStart": "2023-11-07T05:31:56Z",
      "customer": {
        "id": "<string>",
        "number": "<string>",
        "name": "<string>"
      },
      "subscriptionId": "<string>",
      "details": {}
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 25,
    "total": 112,
    "sum": {
      "amount": "1234.56",
      "currency": "EUR"
    },
    "asOf": "2023-11-07T05:31:56Z"
  },
  "counts": {
    "error": 0,
    "warning": 3,
    "info": 12
  },
  "catalog": [
    {
      "code": "PRICE_HISTORY_UNKNOWN",
      "label": "Preisverlauf unbekannt",
      "explanation": "<string>"
    }
  ]
}

{
  "status": 409,
  "type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
  "title": "An error occurred",
  "detail": "<string>"
}

{
  "status": 422,
  "type": "https://tools.ietf.org/html/rfc2616#section-10",
  "violations": [
    {
      "propertyPath": "to",
      "message": "Der Zeitraum darf höchstens 36 Monate umfassen.",
      "code": "analytics.mrr_financials.range_too_long"
    }
  ],
  "title": "Validation Failed",
  "detail": "<string>"
}

GET

api

analytics

mrr-financials

findings

Data-quality findings of the MRR calculation

curl --request GET \
  --url https://coreapi.io/api/analytics/mrr-financials/findings \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://coreapi.io/api/analytics/mrr-financials/findings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/api/analytics/mrr-financials/findings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "<string>",
      "code": "PRICE_HISTORY_UNKNOWN",
      "codeLabel": "Preisverlauf unbekannt",
      "severity": "error",
      "message": "<string>",
      "entityType": "<string>",
      "entityId": "<string>",
      "monthStart": "2023-11-07T05:31:56Z",
      "customer": {
        "id": "<string>",
        "number": "<string>",
        "name": "<string>"
      },
      "subscriptionId": "<string>",
      "details": {}
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 25,
    "total": 112,
    "sum": {
      "amount": "1234.56",
      "currency": "EUR"
    },
    "asOf": "2023-11-07T05:31:56Z"
  },
  "counts": {
    "error": 0,
    "warning": 3,
    "info": 12
  },
  "catalog": [
    {
      "code": "PRICE_HISTORY_UNKNOWN",
      "label": "Preisverlauf unbekannt",
      "explanation": "<string>"
    }
  ]
}

{
  "status": 409,
  "type": "ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED",
  "title": "An error occurred",
  "detail": "<string>"
}

{
  "status": 422,
  "type": "https://tools.ietf.org/html/rfc2616#section-10",
  "violations": [
    {
      "propertyPath": "to",
      "message": "Der Zeitraum darf höchstens 36 Monate umfassen.",
      "code": "analytics.mrr_financials.range_too_long"
    }
  ],
  "title": "Validation Failed",
  "detail": "<string>"
}

Autorisierungen

Authorization

string

header

erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Abfrageparameter

severity

enum<string>

Only findings of this severity.

Verfügbare Optionen:

error,

warning,

info

code

string

Only findings with this code, e.g. BILLED_VS_CONTRACT_DIFF.

customerId

string<uuid>

Only findings of this customer.

month

string

Only findings of this month (YYYY-MM).

page

integer

Standard:1

Page, starting at 1.

Erforderlicher Bereich: x >= 1

pageSize

integer

Standard:25

Findings per page.

Erforderlicher Bereich: 1 <= x <= 200

Antwort

One page of findings.

One page of data-quality findings, most severe first.

data

object[]

Findings of this page.

Show child attributes

Einführung

Grundlagen

Pläne

Angebote

Finanzberichte

Provisionen

Zahlungspläne

Data-quality findings of the MRR calculation

Autorisierungen

Abfrageparameter

Antwort