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

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v2/{app_id}/reports/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "<p>Example report description</p>",
      "inputs": {
        "end_date": "2023-11-02",
        "start_date": "2022-10-01"
      },
      "public": true,
      "template_id": "example-template-1",
      "title": "Example report title"
    }),
});
const data = await response.json();

Response

200422

{
  "components": [
    {
      "data": {
        "container_id": "123",
        "legend": {
          "items": [
            {
              "color": "#008000",
              "title": "Value A"
            },
            {
              "color": "#ffa500",
              "title": "Value B"
            }
          ],
          "legend_type": "basic"
        },
        "maptiles_url": "https://example.com/z/x/y",
        "name": "Layer name",
        "widget_url": "https://example.com/widget/e/N4IgDgTg9gVgpgYwC4EkAmIBcBGADAVgGYAaECOMKCVDTQ3ADlISgFtKA7ODmrAFnwMA7KQDuASzQBzOEgAqATzBwsZClSQB9FuyhceIAL5A"
      },
      "id": 123,
      "report_component_type": "layer",
      "status": "FINISHED"
    },
    {
      "data": {
        "container_id": "1234",
        "layers": [
          {
            "maptiles_url": "https://example.com/z/x/y",
            "name": "Layer name 1"
          },
          {
            "maptiles_url": "https://example.com/z/x/y",
            "name": "Layer name 2"
          }
        ],
        "legend": {
          "items": [
            {
              "color": "#008000",
              "title": "Value A"
            },
            {
              "color": "#ffa500",
              "title": "Value B"
            }
          ],
          "legend_type": "basic"
        },
        "name": "Layer group name",
        "widget_url": "https://example.com/widget/e/N1IgDgTg9gVgpgYwC4EkAmIBcBGADAVgGYAaECOMKCVDTQ3ADlISgFtKA7ODmrAFnwMA7KQDuASzQBzOEgAqATzBwsZClSQB9FuyhceIAL4A"
      },
      "id": 124,
      "report_component_type": "layer_group",
      "status": "FINISHED"
    },
    {
      "data": {
        "chart_url": "https://example.com/some_chart_data.csv",
        "configuration": {
          "bars": [
            {
              "color": "#ffc9c9",
              "data_key": "key1",
              "name": "Bar name"
            }
          ],
          "chart_type": "bar",
          "xaxis": {
            "data_key": "xkey",
            "data_type": "category"
          },
          "yaxis": {
            "unit": "ha"
          }
        },
        "name": "Chart",
        "widget_url": "https://example.com/widget/e/N2IgDgTg9gVgpgYwC4EkAmIBcBGADAVgGYAaECOMKCVDTQ3ADlISgFtKA7ODmrAFnwMA7KQDuASzQBzOEgAqATzBwsZClSQB9FuyhceIAL1A"
      },
      "id": 125,
      "report_component_type": "chart",
      "status": "FINISHED"
    },
    {
      "data": {
        "computed_variables": {
          "area_gain": 13,
          "total_area": 1343
        },
        "configuration": {
          "label": "Some label",
          "unit": "C",
          "value": "{{area_gain | divided_by: total_area}}"
        },
        "name": "Stat",
        "stat_type": "simple_stat",
        "widget_url": "https://example.com/widget/e/D2IgDgTg9gVgpgYwC4EkAmIBcBGADAVgGYAaECOMKCVDTQ3ADlISgFtKA7ODmrAFnwMA7KQDuASzQBzOEgAqATzBwsZClSQB9FuyhceIAL1B"
      },
      "id": 126,
      "report_component_type": "stat",
      "status": "FINISHED"
    },
    {
      "data": {
        "details": {
          "message": "Generic error occurred"
        },
        "error": "Generic error"
      },
      "id": 127,
      "report_component_type": "stat",
      "status": "ERROR"
    }
  ],
  "description": "<p>Example report description</p>",
  "inputs": {
    "end_date": "2023-11-02",
    "start_date": "2022-10-01"
  },
  "project_id": 123,
  "status": "FINISHED",
  "title": "Example report title"
}