public

Exécuter une requête de rapport

POST

/v1/reports/query

curl --request POST \
  --url '/v1/reports/query' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "card": "<string>",
  "cardParams": {
    "calendar": "<string>",
    "tagId": "<string>"
  },
  "compareYears": [
    123
  ],
  "dateRole": "<string>",
  "filters": [],
  "groupBy": [
    "<string>"
  ],
  "id": "<string>",
  "limit": 123,
  "listSource": "<string>",
  "measures": [],
  "presentation": {
    "layout": "bars",
    "orientation": "vertical",
    "variant": "default"
  },
  "scope": "mine",
  "sort": {
    "direction": "asc",
    "field": "<string>"
  },
  "subtitle": "<string>",
  "templateId": "<string>",
  "timeRange": "mtd",
  "title": "<string>",
  "visualization": "kpi",
  "widgetId": "<string>"
}
'

{
  "aggregates": {},
  "columns": [
    {
      "helpText": "<string>",
      "id": "<string>",
      "label": "<string>",
      "type": "string"
    }
  ],
  "comparison": {},
  "meta": {
    "computedAt": "2023-11-07T05:31:56Z",
    "rowCount": 123,
    "totals": {},
    "truncated": true
  },
  "rowLinks": [
    "<string>"
  ],
  "rows": [
    {}
  ],
  "series": [
    {
      "name": "<string>",
      "points": [
        {
          "x": "<string>",
          "y": 123
        }
      ]
    }
  ],
  "sparkline": {}
}

Autorisations

Authorizationstringheaderobligatoire

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètre figé à la pose du widget. La clé attendue dépend de card, et elle est OBLIGATOIRE : tagId pour contacts-by-tag, calendar pour external-calendar. Une carte paramétrée sans sa clé est refusée.

Afficher child attributes

compareYearsinteger[]

Maximum array length: 4

dateRolestring

filtersobject[]default:[]

Afficher child attributes

groupBystring[]

idstringobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

limitinteger

Plage requise: 0 < x <= 500

listSourcestring

measuresstring[]default:[]

presentationobject

Afficher child attributes

scopeenum<string>

Options disponibles: mine, cabinet, contributions

sortobject

Afficher child attributes

subtitlestring

templateIdstring

timeRangeenum<string> | object

enum<string>

titlestringobligatoire

Minimum string length: 1

visualizationenum<string>obligatoire

Options disponibles: kpi, line, table, bar, pie, list, card

Réponse

aggregatesobject

columnsobject[]obligatoire

Afficher child attributes

comparisonobject

metaobjectobligatoire

Afficher child attributes

rowLinks(string | null)[]

rowsobject[]obligatoire

seriesobject[]

Afficher child attributes

sparklineobject

Besoin d'aide supplémentaire ? Demander à l'équipe

Autorisations

Corps

Réponse