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
id	string	This component's id. Must be unique within the report	required
content	string	For components such as SECTION_HEADERS and TEXT, this is their text.	optional
visible	boolean	True if this component is visible.	required
type	string	The type of component. Values: SECTION_HEADER TEXT ANALYSIS	required
analysisType	string	For analysis components, this is the type of analysis.	optional
position	object	For reports with dashboard layout, this is the components position within the dashboard.	optional
pageId	string	The id of the page on which this component appears.	required
x	integer	The zero-based horizontal coordinate of this component within the dashboard page.	required
y	integer	The zero-based vertical coordinate of this component within the dashboard page.	required
width	integer	The width of the component, in grid cells.	required
height	integer	The height of the component, in grid cells.	required
subtitle	string	The subtitle text of SECTION_HEADERS	optional
dataUrl	string	For SECTION_HEADERS in a dashboard, a data-url containing the logo.	optional
visualizationType	string	For pivot analyses, this is the type of visualization. Values: TABLE BARCHART LINECHART PIECHART	optional
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
forms	array[string]		required
calculatedTables	array[object]		required
id	string		required
alias	string		required
formula	string		required
editType	string	Values: EDITABLE COPYABLE READABLE	required
pages	array[object]	For reports with DASHBOARD layout, the list of pages.	required
id	string		required
label	string		optional

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