Skip to main content
GET
/
receive
/
metrics
/
jobs
/
{jobId}
View job details
curl --request GET \
  --url https://{host}/receive/metrics/jobs/{jobId}
{
  "jobId": "<string>",
  "name": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "audit_info": {
    "audit_name": "<string>",
    "audit_date": "<string>",
    "audit_path": "<string>",
    "target_audit": 123,
    "targets_failed": 123,
    "audit_end_date": "<string>",
    "load_date": "<string>",
    "load_end_date": "<string>",
    "load_status": "<string>"
  },
  "input_files": [
    {
      "name": "<string>",
      "size": 123
    }
  ],
  "lines_to_tail_in_logs": 123,
  "logs": [
    {
      "name": "<string>",
      "contents": "<string>"
    }
  ],
  "job_status": {
    "code": 123,
    "message": "<string>",
    "files": [
      {
        "name": "<string>",
        "size": 123
      }
    ]
  }
}

Path Parameters

jobId
string
required

Job GUID.

Query Parameters

lines_to_tail_in_logs
integer
default:-1

Tail N lines from each log; -1 returns the entire file.

Response

Job details

jobId
string
name
string
parameters
object[]
audit_info
object

Last audit details, when present.

input_files
object[]
lines_to_tail_in_logs
integer
logs
object[]
job_status
object

Status of the last/active job operation:

  • code: 0 success; -1 error (or last audit load code if no statuscode.txt)
  • message: from statusmessage.txt (or last audit load status)
  • files: non-status files in the job status folder.