Get report

Request

GET https://www.activityinfo.org/resources/reports/{reportId}

Successful response

application/json

object
id string The id of the report. required
ownerType string Values:
PERSONAL
This is a personal report and will be found in the "My Reports" section.
DATABASE
This report is part of a database.
required
ownerId string If this is a personal report, then this the id of the user who owns the report. optional
ownerName string If this is a personal report, then this is the name of the user who owns the report. required
databaseId string If this report is part of a database, then this is the id of the database to which it belongs. optional
label string The human-readable label of this report. required
published boolean True if this report has been published. required
components array[object] The list of components in this report. required
layout string The layout of this report's components.Values:
SINGLE
This report has a single analysis.
NOTEBOOK
This report's components are laid out vertically.
DASHBOARD
This report's components are arranged in a grid across multiple pages.
required
icon string The icon to use when listing this report. required
sources object The data sources that are included in this report. required
editType string Values:
EDITABLE
COPYABLE
READABLE
required
pages array[object] For reports with DASHBOARD layout, the list of pages. required

Error responses

Status Code Error Code Description
401 AUTHENTICATION_REQUIRED The request must be authenticated
403 NOT_PUBLISHED
403 PERMISSION_DENIED
404 NOT_FOUND

Example

curl -u anything:YOUR_API_TOKEN \
  https://www.activityinfo.org/resources/reports/cht8p4kdeimokm5

The above command returns JSON structured like this:

{
  "id": "cht8p4kdeimokm5",
  "ownerType": "PERSONAL",
  "ownerId": "432201",
  "ownerName": "",
  "databaseId": null,
  "label": "My report",
  "published": true,
  "grants": {
    "roles": [
      
    ]
  },
  "layout": "SINGLE",
  "icon": "",
  "sources": {
    "forms": [
      "ck8pu9ha07"
    ],
    "calculatedTables": [
      
    ]
  },
  "components": [
    {
      "id": "cv5wyndkqv9yuuq2",
      "type": "ANALYSIS",
      "content": "My table",
      "subtitle": null,
      "analysisType": "pivot",
      "visualizationType": null,
      "dataUrl": null,
      "visible": true,
      "position": null
    }
  ],
  "editType": "EDITABLE",
  "pages": [
    
  ]
}
Next item
Get report rows