Skip to main content
GET
/
reports
/
schedules
/
{schedule_id}
/
runs
Get Schedule History
curl --request GET \
  --url https://analyst.heyhumm.ai/reports/schedules/{schedule_id}/runs \
  --header 'Authorization: Bearer <token>'
{
  "schedule": {
    "command_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cron_expression": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "next_run_time": "2023-11-07T05:31:56Z",
    "last_run_time": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "timezone": "UTC",
    "enabled": true,
    "name": "<string>",
    "run_mode": "per_subscriber",
    "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "command_name": "<string>",
  "runs": [
    {
      "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_email": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "error_message": "<string>",
      "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "summary": "<string>",
      "is_read": true,
      "read_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "is_source_run": true,
      "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "pagination": {}
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
schedule_id
string<uuid>
required

Schedule ID

Query Parameters

​
organization_id
string
required
​
limit
integer
default:20

Number of runs per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of runs to skip

Required range: x >= 0

Response

Successful Response

Response for schedule history endpoint.

​
schedule
CommandScheduleResponse · object
required

Response model for command schedule.

​
command_name
string
required
​
runs
CommandRunResponse · object[]
required
​
pagination
Pagination · object
required