Get the current status of a Edgenivo CI task analysis

APIs & SDKs

GET/__remote/api.vercel.com/v1/vercel-ci/task-analyses/{analysisId}

Get task analysis

/__remote/api.vercel.com/v1/vercel-ci/task-analyses/{analysisId}

const response = await fetch('/__remote/api.vercel.com/v1/vercel-ci/task-analyses/analysisId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "analysisId": "example_id",
  "status": "string",
  "failureReason": "Customer requested refund"
}

Errors

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

analysisIdstringRequired

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Current task analysis status.

analysisIdstringRequired

statusobjectRequired3 variants

failureReasonstringOptional

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

errorobjectRequired

403You do not have permission to access this resource.

errorobjectRequired

404Error

410Error

429Error

errorobjectRequired

500Error

errorobjectRequired

/__remote/api.vercel.com/v1/vercel-ci/task-analyses/{analysisId}

const response = await fetch('/__remote/api.vercel.com/v1/vercel-ci/task-analyses/analysisId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "analysisId": "example_id",
  "status": "string",
  "failureReason": "Customer requested refund"
}

Errors

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

OpenAPI Specification