Skip to content

List Report Runs

List all report runs

To see all runs of the specific report template, use the following endpoint:

GET /api/v2/reports/<report-id>/runs.json

Example of response:

{
  "report_runs": [
    {
      "run_id": "8f6a533b-187b-4e99-a0e5-48fe58b53f16",
      "report_id": "1c455456-1cca-4223-a366-7bf5a1817778",
      "name": "Calls Summary Report by Group",
      "description": null,
      "run_tenant_id": "9d27913a-b7c3-11ed-9277-1207ffee24c3",
      "run_user_id": "649c4a50-172a-498d-acd7-d3b5321a880e",
      "created_at": "2024-10-02T10:19:07.574498-07:00",
      "period_begin": "2024-08-01T00:00:00-07:00",
      "period_end": "2024-10-02T00:00:00-07:00",
      "timezone": "America/Los_Angeles",
      "filters": [
        {
          "param": "duration",
          "param2": "",
          "op": "duration_greater_than",
          "val": "1:00"
        }
      ],
      "email_report": false,
      "email_report_settings": {
        "send_to_emails": []
      },
      "summary_settings": [
        {
          "name": "count_calls",
          "header": "Calls - Total Calls"
        },
        {
          "name": "minutes_total",
          "header": "Calls - Total Minutes"
        },
        {
          "name": "n_rows",
          "header": "# of rows"
        }
      ],
      "chart_settings": {
        "chart_style": "bar",
        "dimensions": [
          {
            "name": "group_name",
            "header": "Group - Name"
          }
        ],
        "metrics": [
          {
            "name": "count_calls",
            "header": "Calls - Total Calls"
          },
          {
            "name": "minutes_total",
            "header": "Calls - Total Minutes"
          }
        ]
      },
      "column_settings": [
        {
          "name": "group_name",
          "header": "Group - Name",
          "text_align": "left"
        },
        {
          "name": "count_calls",
          "header": "Calls - Total Calls",
          "text_align": "right"
        },
        {
          "name": "minutes_total",
          "header": "Calls - Total Minutes",
          "text_align": "right"
        }
      ],
      "sort_settings": [
        {
          "name": "group_name",
          "header": "group_name",
          "sort": "ASC"
        }
      ],
      "started_at": "2024-10-02T10:19:07.614593-07:00",
      "completed_at": "2024-10-02T10:19:07.885709-07:00",
      "celery_status": "SUCCESS",
      "_version_": 1
    },
    {
      "run_id": "97a82bfa-3e37-4f41-a730-c0ef31b2f008",
      "report_id": "1c455456-1cca-4223-a366-7bf5a1817778",
      "name": "Calls Summary Report by Group",
      "description": null,
      "run_tenant_id": "9d27913a-b7c3-11ed-9277-1207ffee24c3",
      "run_user_id": "649c4a50-172a-498d-acd7-d3b5321a880e",
      "created_at": "2024-10-02T10:18:41.209988-07:00",
      "period_begin": "2023-10-04T00:00:00-07:00",
      "period_end": "2024-10-03T00:00:00-07:00",
      "timezone": "America/Los_Angeles",
      "filters": [
        {
          "param": "duration",
          "param2": "",
          "op": "duration_greater_than",
          "val": "1:00"
        }
      ],
      "email_report": false,
      "email_report_settings": {
        "send_to_emails": []
      },
      "summary_settings": [
        {
          "name": "count_calls",
          "header": "Calls - Total Calls"
        },
        {
          "name": "minutes_total",
          "header": "Calls - Total Minutes"
        },
        {
          "name": "n_rows",
          "header": "# of rows"
        }
      ],
      "chart_settings": {
        "chart_style": "bar",
        "dimensions": [
          {
            "name": "group_name",
            "header": "Group - Name"
          }
        ],
        "metrics": [
          {
            "name": "count_calls",
            "header": "Calls - Total Calls"
          },
          {
            "name": "minutes_total",
            "header": "Calls - Total Minutes"
          }
        ]
      },
      "column_settings": [
        {
          "name": "group_name",
          "header": "Group - Name",
          "text_align": "left"
        },
        {
          "name": "count_calls",
          "header": "Calls - Total Calls",
          "text_align": "right"
        },
        {
          "name": "minutes_total",
          "header": "Calls - Total Minutes",
          "text_align": "right"
        }
      ],
      "sort_settings": [
        {
          "name": "group_name",
          "header": "group_name",
          "sort": "ASC"
        }
      ],
      "started_at": "2024-10-02T10:18:41.249259-07:00",
      "completed_at": "2024-10-02T10:18:41.551902-07:00",
      "celery_status": "SUCCESS",
      "_version_": 1
    }
  ],
  "total": 2,
  "next_url": null
}

See also Paging through collections