DokuBrain
API Reference

Reports

Report creation, execution, and scheduling

List reports

GET
/reports

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Query Parameters

typestring
categorystring
searchstring
pageinteger
per_pageinteger
curl -X GET "https://api.dokubrain.com/api/v1/reports?type=%3Cstring%3E&category=%3Cstring%3E&search=%3Cstring%3E&page=0&per_page=0" \
  -H "Authorization: Bearer <token>"

Report list

{
  "success": true,
  "data": {},
  "message": "string"
}

Create a report

POST
/reports

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Request Body

application/jsonRequired
nameRequiredstring
typeRequiredstring
descriptionstring
categorystring
data_sourceobject
filtersobject
tagsarray<string>
curl -X POST "https://api.dokubrain.com/api/v1/reports" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "type": "string",
    "description": "string",
    "category": "string",
    "data_source": {},
    "filters": {},
    "tags": [
      "string"
    ]
  }'

Report created

{
  "success": true,
  "data": {},
  "message": "string"
}

Get report details

GET
/reports/{id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.dokubrain.com/api/v1/reports/<string>" \
  -H "Authorization: Bearer <token>"

Report details

{
  "success": true,
  "data": {},
  "message": "string"
}

Delete a report

DELETE
/reports/{id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://api.dokubrain.com/api/v1/reports/<string>" \
  -H "Authorization: Bearer <token>"

Report deleted

{
  "success": true,
  "data": {},
  "message": "string"
}

Execute a report

POST
/reports/{id}/run

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

idRequiredstring
curl -X POST "https://api.dokubrain.com/api/v1/reports/<string>/run" \
  -H "Authorization: Bearer <token>"

Report execution started

{
  "success": true,
  "data": {},
  "message": "string"
}

Get report schedule

GET
/reports/{id}/schedule

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.dokubrain.com/api/v1/reports/<string>/schedule" \
  -H "Authorization: Bearer <token>"

Schedule details

{
  "success": true,
  "data": {},
  "message": "string"
}

Schedule recurring report execution

POST
/reports/{id}/schedule

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Request Body

application/jsonRequired
timeRequiredstring
frequencystring
Value in: "daily" | "weekly" | "monthly"
timezonestring

Path Parameters

idRequiredstring
curl -X POST "https://api.dokubrain.com/api/v1/reports/<string>/schedule" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "time": "string",
    "frequency": "daily",
    "timezone": "string"
  }'

Schedule created

{
  "success": true,
  "data": {},
  "message": "string"
}

Previous

Templates

Next

API Keys