Create

Create New Report

Create new report using provided template_id.

Templates

Orbify provides a catalogue of predefined report templates. Additionally, you can use the application to generate and save a custom report template.

All the available templates as well as their identifiers can be fetched using the Get Report Templates API.

POST/api/v2/{app_id}/reports/create

Authorization

OAuth2AuthorizationCodeBearerAPIKeyHeaderAPIKeyQuery

Path parameters

app_id*App Id

Body

application/json

template_id*Template Id

Template id

title*Title

Report title

descriptionDescription

Report description

stringnull

publicPublic

Report public setting

booleannull

inputs*all of

Report inputs

refresh_frequencyany of

Report refresh frequency, can be one of: MONTHLY, YEARLY, OFF

ReportScheduleFrequencynull

project_id*Project Id

Project id

Response

200422

Successful Response

Body

application/json

id*Id

Report id

project_id*Project Id

Project id

integernull

title*Title

Report title

stringnull

descriptionDescription

Report description

stringnull

public_report_dashboard_urlPublic Report Dashboard Url

URL to public report dashboard UI

stringnull

private_report_dashboard_urlPrivate Report Dashboard Url

URL to private report dashboard UI

stringnull

inputs*all of

Report inputs

refresh_frequencyany of

Report refresh frequency, can be one of: MONTHLY, YEARLY, OFF

ReportScheduleFrequencynull

status*all of

Report calculation status

components*Components

Report components

Request

JavaScriptCurlPython

const response = await fetch('/api/v2/{app_id}/reports/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "template_id": "text",
      "title": "text",
      "inputs": {
        "start_date": "2024-12-31",
        "end_date": "2024-12-31"
      },
      "project_id": 0
    }),
});
const data = await response.json();

Response

200422

{
  "id": 0,
  "project_id": 0,
  "title": "text",
  "description": "text",
  "public_report_dashboard_url": "text",
  "private_report_dashboard_url": "text",
  "inputs": {
    "start_date": "2024-12-31",
    "end_date": "2024-12-31"
  },
  "refresh_frequency": "monthly",
  "status": {},
  "components": [
    {
      "id": 0,
      "status": {},
      "report_component_type": "text",
      "error": {
        "error": "text"
      }
    }
  ]
}