evaluations

Access evaluation results

evaluations#list

List evaluations

Request
query Parameters
accountIdentifier
string
Default: ""

Harness account ID

Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier
string
Default: ""

Harness organization ID

Example: orgIdentifier=test-org
projectIdentifier
string
Default: ""

Harness project ID

Example: projectIdentifier=test-project
per_page
integer <int64> [ 1 .. 100 ]
Default: 50

Number of results per page

Example: per_page=20
page
integer <int64> >= 0
Default: 0

Page number (starting from 0)

Example: page=4
entity
string

Filter by the entity associated with the evaluation

Example: entity=7bbca5d4-e9f2-4955-9b2a-019ec4d3645e
type
string

Filter by the type associated with the evaluation

Example: type=pipeline
action
string

Filter by the action associated with the evaluation

Example: action=onrun
last_seen
integer <int64>

Retrieve results starting after this last-seen result

Example: last_seen=123
created_date_from
integer <int64>

Retrieve results created from this date

Example: created_date_from=123
created_date_to
integer <int64>

Retrieve results created up to this date

Example: created_date_to=123
status
string

Retrieve results with these statuses

Example: status=SUCCESS,WARNING,FAILED
includeChildScopes
boolean
Default: false

When true, evaluations from child scopes will be inculded in the results

Example: includeChildScopes=true
header Parameters
x-api-key
string

Harness PAT key used to perform authorization

Example: Ab fuga.
Responses
200

OK response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

get/pm/api/v1/evaluations
Request samples
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

evaluations#find

Find an evaluation by ID

Request
path Parameters
id
required
integer <int64>

The ID of the evaluation to retrieve

Examples:
123
query Parameters
accountIdentifier
string
Default: ""

Harness account ID

Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier
string
Default: ""

Harness organization ID

Example: orgIdentifier=test-org
projectIdentifier
string
Default: ""

Harness project ID

Example: projectIdentifier=test-project
header Parameters
x-api-key
string

Harness PAT key used to perform authorization

Example: Sapiente rerum excepturi ut omnis deleniti.
Responses
200

OK response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

get/pm/api/v1/evaluations/{id}
Request samples
Response samples
application/json
{
  • "account_id": "XRQAjvT37acOiXx9PRaQMF",
  • "action": "onrun",
  • "created": 1636370209475,
  • "details": [
    ],
  • "entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
  • "entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
  • "id": 123,
  • "input": "",
  • "org_id": "test-org",
  • "project_id": "test-project",
  • "status": "error",
  • "type": "pipeline,service"
}