Reports | Orbify

Get Report

Retrieve existing report

GET/api/v2/{app_id}/reports/{report_id}

Authorization

Path parameters

app_id*App Id

report_id*Report Id

Response

Successful Response

Body

id*Id

Report id

project_id*Project Id

Project id

title*Title

Report title

descriptionDescription

Report description

public_report_dashboard_urlPublic Report Dashboard Url

URL to public report dashboard UI

private_report_dashboard_urlPrivate Report Dashboard Url

URL to private report dashboard UI

inputs*all of

Report inputs

refresh_frequencyany of

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

status*all of

Report calculation status

components*Components

Report components

Request

const response = await fetch('/api/v2/{app_id}/reports/{report_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "title": "text",
  "description": "text",
  "public_report_dashboard_url": "text",
  "private_report_dashboard_url": "text",
  "inputs": {
    "start_date": "2024-11-21",
    "end_date": "2024-11-21"
  },
  "refresh_frequency": "monthly",
  "status": {},
  "components": [
    {
      "status": {},
      "report_component_type": "text",
      "error": {
        "error": "text"
      }
    }
  ]
}

Update Report

Update existing report

PUT/api/v2/{app_id}/reports/{report_id}

Authorization

Path parameters

app_id*App Id

report_id*Report Id

Body

titleTitle

Report title

descriptionDescription

Report description

inputsany of

Report inputs

publicPublic

Report public setting

refresh_frequencyany of

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

Response

Successful Response

Body

id*Id

Report id

project_id*Project Id

Project id

title*Title

Report title

descriptionDescription

Report description

public_report_dashboard_urlPublic Report Dashboard Url

URL to public report dashboard UI

private_report_dashboard_urlPrivate Report Dashboard Url

URL to private report dashboard UI

inputs*all of

Report inputs

refresh_frequencyany of

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

status*all of

Report calculation status

components*Components

Report components

Request

const response = await fetch('/api/v2/{app_id}/reports/{report_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "description": "text",
  "public_report_dashboard_url": "text",
  "private_report_dashboard_url": "text",
  "inputs": {
    "start_date": "2024-11-21",
    "end_date": "2024-11-21"
  },
  "refresh_frequency": "monthly",
  "status": {},
  "components": [
    {
      "status": {},
      "report_component_type": "text",
      "error": {
        "error": "text"
      }
    }
  ]
}

Delete Report

Delete existing report

DELETE/api/v2/{app_id}/reports/{report_id}

Authorization

Path parameters

app_id*App Id

report_id*Report Id

Response

Successful Response

Body

any

Request

const response = await fetch('/api/v2/{app_id}/reports/{report_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}