Skip to content

List Evaluation Reports

List all reports:

GET /api/v2/evaluation_reports.json

Note

This API endpoint returns a compact list of report attributes only. To retrieve all the report attributes, check View an Evaluation Report.

Example of response:

{
    "reports": [
        {
            "report_id": "f28197dc-80a4-47f2-9778-020bc2e87132",
            "form_id": "cd61b307-5e74-4c4b-b50a-f47100d51959",
            "title": "Inbound Score Card",
            "status": "completed",
            "agent_user_id": "f56a384a-9e26-4ed6-96fe-e4976e1a0448",
            "report_points": 50,
            "report_max_points": 95
        },
        {
            "report_id": "def48768-db17-411b-928f-a673b1b01509",
            "form_id": "cd61b307-5e74-4c4b-b50a-f47100d51959",
            "title": "Inbound Score Card",
            "status": "completed",
            "agent_user_id": "f56a384a-9e26-4ed6-96fe-e4976e1a0448",
            "report_points": 75,
            "report_max_points": 95
        },
        {
            "report_id": "679e35ba-ce7d-48a5-b97b-fae9e2da7150",
            "form_id": "cd61b307-5e74-4c4b-b50a-f47100d51959",
            "title": "Inbound Score Card",
            "status": "completed",
            "agent_user_id": "bcdf85e8-f495-44f1-9d89-99c9a04813fe",
            "report_points": 55,
            "report_max_points": 95
        }
    ],
    "total": 3,
    "next_url": null
}

See also Paging through collections

Search reports:

  • Search by date range:

    GET /api/v2/evaluation_reports.json?daterange=2014/11/01-2014/12/01

    Filter reports by date range. Format of daterange is YYYY/MM/DD-YYYY/MM/DD.

    Note, this filter is applied to call date/time rather than evalution report creation date.

    The query will be executed with REST API user's timezone. If user's timezone is not configured, then tenant's or system default timezone will be used.

  • Search by name:

    GET /api/v2/evaluation_reports.json?search_term=MyForm

  • Search by tenant id

    GET /api/v2/evaluation_reports.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff

  • Search by evaluation form id

    GET /api/v2/evaluation_reports.json?evaluation_form_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff

  • Search by evaluator user id

    GET /api/v2/evaluation_reports.json?evaluator_user_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff

  • Search by evaluated user id

    GET /api/v2/evaluation_reports.json?user_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff

  • Search by group id

    GET /api/v2/evaluation_reports.json?group_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff

  • Search by multiple parameters (tenant_id and search_term)

    GET /api/v2/evaluation_forms.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff&search_term=Contoso