ReferenceEndpoints

List report columns

Every report type with its columns, types and defaults, plus your custom fields.

GET/api/v1/reports

Parameters

No parameters.

Example

curl "/api/v1/reports" \
  -H "Authorization: Bearer $PLANIFIZER_API_KEY"
{
  "types": [
    {
      "type": "agent-days",
      "title": "Hours per agent per day",
      "path": "/api/v1/reports/agent-days",
      "default_fields": [
        "activity_code",
        "agent_id",
        "agent_code",
        "date",
        "first_start",
        "last_end",
        "shift_time",
        "break_unpaid",
        "paid_time"
      ],
      "fields": [
        {
          "id": "paid_time",
          "label": "Paid time",
          "description": "Shift time minus unpaid breaks, plus paid time off",
          "type": "duration",
          "group": "totals",
          "default": true,
          "requires": null,
          "live_only": false
        }
      ]
    }
  ],
  "custom_fields": {
    "agent": [
      {
        "id": "cf.matricule",
        "key": "matricule",
        "label": "Matricule",
        "type": "string"
      }
    ],
    "client": [
      {
        "client": {
          "code": "CL-0004",
          "name": "FREE"
        },
        "fields": [
          {
            "id": "ccf.code_campagne",
            "key": "code_campagne",
            "label": "Code campagne",
            "type": "string"
          }
        ]
      }
    ]
  }
}
List report columns — Planifizer API docs