projects.jobs.runs

Get Job Runs

Get all JobRuns for a Job.

get/{workspaceId}/projects/{projectName}/jobs/{jobId}/runs

Request

Base URL
https://app.intuned.io/api/v1/workspace
Auth
API key in header x-api-key

Path parameters

workspaceIdstring uuid required

Your workspace ID. How to find it?

projectNamestring required

The name you assigned when creating the Project.

jobIdstring required

The ID you assigned when creating the Job.

Query parameters

pageSizestring

Number of items per page (defaults to 10)

Example:10

pageNumberstring

Page number for pagination (defaults to 0)

Example:0

sortBystring

Sorting parameter in format 'column,order/column2,order2'. Order can be 'asc' or 'desc'

Example:start_time,desc/status,asc

Response

Array of JobRuns with pagination info.

totalCountinteger required

Total number of JobRuns available.

Example response

{
  "jobRuns": [
    {
      "id": "jr_abc123def456ghi789xyz",
      "start_time": "2024-01-01T00:00:00Z",
      "end_time": "2024-01-01T00:30:00Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "job_id": "job-123e4567-e89b-12d3",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "type": "SCHEDULED",
      "status": "SUCCESS",
      "payloads": 100,
      "successful_runs": 95,
      "failed_runs": 5,
      "error": {
        "message": "An error occurred while executing the job",
        "code": "internal-server-error",
        "correlationId": "123e4567-e89b-12d3-a456-426614174000",
        "doc_url": "https://intunedhq.com/docs/main/support/errors"
      },
      "reason": {
        "doc_url": "https://intunedhq.com/docs/main/support/reasons#no-valid-output-received"
      },
      "job_configuration_snapshot": {
        "configuration": {
          "retry": {
            "maximumAttempts": 3
          },
          "requestTimeout": 600,
          "proxy": "http://username:password@proxy.example.com:8080"
        },
        "sink": {
          "url": "https://example.com/webhook",
          "headers": {
            "Content-Type": "application/json",
            "Authorization": "Bearer token"
          },
          "apisToSend": [
            "api1",
            "api2"
          ]
        },
        "auth_session": {
          "id": "auth-session-123"
        },
        "notifications": [
          {
            "url": "https://example.com/webhook",
            "headers": {
              "Content-Type": "application/json",
              "Authorization": "Bearer token"
            }
          }
        ]
      }
    }
  ],
  "totalCount": 150
}

Changes

No recorded changes to this operation across all 1 revision of this API.