The report data API: parameters, rows and values in detail

This page gives the details of the report call in the report data API: what each parameter does, which rows and columns the answer has, and how each value is written. The token, the header and the address of the call are in The report data API; setting it up with your IT department is in Get report data into Power BI or another tool.

Parameters of the report call

Parameter	What it does	When it is left out
`count`	The number of rows per page, as a whole number. ABMS sets no maximum.	No rows are returned.
`page`	Which page to return; 1 is the first page. Page 2 starts after the first `count` rows.	The first page is returned.
`language`	`en` or `no`. Decides the language of the column names, the list values and the statuses, and the date format of Created and Last updated: 16.06.2026 for `no`, 16/06/2026 for `en`.	The API user’s own language is used.
`sort`	The column to sort by, given as its position in the report’s saved column order, counting from 0 for the first column. A position that does not exist sorts by the first column.	The report’s own saved sort is used; a report without one is sorted by Last updated, newest first.
`reverse`	`1` sorts descending, `0` ascending.	The report’s own saved direction is used.
`search`	A search text, with the same rules as the search box on the report page; see Which documents a report shows: document types, filters, search and sorting.	No search.
`archived`	`1` includes archived documents; see the rows below.	Archived documents are left out.
`from`, `to`	Are accepted but do not change the answer of the report call.	—

Which rows the answer has

Rule	Detail
Document types	The report’s document types (new, in progress, completed) apply.
Archived documents	Decided by the `archived` parameter, not by the report’s own archived switch. With `archived=1`, all archived documents are added to the documents of the report’s other types. A report set up to show only archived documents returns no rows unless `archived=1` is sent.
Main filter	The report’s main filter applies.
Personal filters	Personal filters that the API user has set on the report in ABMS also apply. Give the API user no personal filters if the tool should get the same rows as the report shows a user with no personal filters.
`documents_count`	The total number of documents that match, across all pages.

Which columns each row has

Rule	Detail
Columns	The report’s saved columns, in the report’s saved order. The API user’s own column order in ABMS is not used.
Names	Each value is named after the column title in the chosen language.
Left out	The Delete column is never included. The observation column is left out when the module’s workflow does not allow saving as an observation, Sent External when no step can be sent outside ABMS, and Status when the module has no statuses set.
Last entry	The link to the document.

How values are written

Column or field type	Value
Created, Last updated	The date as text in the format of the chosen language.
Responsible	The user’s full name, followed by “[Deactivated]” for a deactivated user, or “No User” when the step has no user. Both texts are in English, also with `language=no`.
Status	The status name in the chosen language. An archived document has “Archived” (“Arkivert” with `language=no`).
Sent External	“Yes” or “No” (“Ja” or “Nei”).
Dropdown, option buttons, tick boxes	The value names in the chosen language; several values are separated by commas.
Checklist	The number of ticked tasks and the total, for example “3/5”.
Connected dropdown	The chosen values separated by commas, or the full path with “ - “ between the levels when the dropdown is set up to show the full path.
Upload field	A list with one entry per file, each with `title` (the file name) and `url` (its web address).
Other columns (date fields, numbers, Revision number, global fields, the observation column)	The same value as in the Excel export; see Report exports: what the Excel and PDF files contain.
Risk field	An entry with `value` (the number, or NA) and `color_code`: the risk colour as a hexadecimal code when Show colors is switched on for the module, otherwise empty.

Next step

Get report data into Power BI or another tool