Skip to main content
GET
/
api
/
public
/
v1
/
reports
/
{id}
Get report
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/reports/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "isShared": true,
    "version": 123,
    "coverImageUrl": "<string>",
    "dateStart": "<string>",
    "dateEnd": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyName": "<string>",
    "reportTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportTypeName": "<string>",
    "reportTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "authorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "reportStructure": {
      "blocks": [
        {
          "id": "<string>",
          "type": "<string>",
          "params": {},
          "layout": {
            "x": 1,
            "y": 1,
            "w": 2,
            "h": 2
          }
        }
      ],
      "metadata": {
        "title": "<string>",
        "subtitle": "<string>",
        "showHeader": true,
        "showFooter": true,
        "showPageNumbers": true
      },
      "pagePreset": "<string>",
      "displaySettings": {
        "pageSize": "<string>",
        "orientation": "<string>",
        "margins": {}
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

​
id
string<uuid>
required

Report ID

Query Parameters

​
includeStructure
enum<string>

Include full report structure in response

Available options:
true,
false

Response

Report details (with or without structure based on query param)

​
data
object
required