Get report

GET

/api/v1/reports/{id}

const url = 'https://example.com/api/v1/reports/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/reports/example

Parameters

Path Parameters

required

string

Responses

200

Success

application/json

object

_id

required

string

requestId

required

string

templateId

string

reporter

object

required

string

name

required

string

gitHash

required

string

model

required

string

agentId

required

string

agentVersion

required

string

content

string

status

required

string

Allowed values: pending generating completed failed

error

string

insightReferences

Array<object>

object

insightId

required

string

referencedAt

required

string | null format: date-time

isNew

required

boolean

createdAt

required

string | null format: date-time

updatedAt

string | null format: date-time

projectId

required

string

Example

{
  "status": "pending"
}

404

Report not found