Reports

Create, update and run saved reports.

GET/reportsList saved reports
POST/reportsCreate a report
GET/reports/{id}Get / run a saved report
PATCH/reports/{id}Update a report
DELETE/reports/{id}Delete a report

List saved reports

GET/reports

Scope reports:runRead-only

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/reports" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create a report

POST/reports

Scope reports:createWrites data

Request body

Field	Type
`name`required	string
`description`	string
`source`	string
`saql`	string
`raw`	boolean
`view`	"table" \| "chart" \| "both"

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/reports" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name":"…","description":"…","source":"…","saql":"…","raw":false,"view":"table"}'

Get / run a saved report

GET/reports/{id}

Scope reports:runRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/reports/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update a report

PATCH/reports/{id}

Scope reports:createWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PATCH "https://api.klerc.co/api/v1/reports/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Delete a report

DELETE/reports/{id}

Scope reports:createWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/reports/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"