Skip to main content
POST
/
v1
/
report
Create report
curl --request POST \
  --url https://staging.api.us.aptlydone.com/v1/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reportName": "Cronin, Sauer and Mraz Status Report",
  "reportType": "DECISIONS",
  "status": "PUBLISHED",
  "tenantId": "ce5e0e52-d47d-4a56-9f31-5546a60e05b8",
  "ownerId": "61e12e68-9391-42a8-b9ea-2c7f51b3c960",
  "description": "Tenus creber tantum nihil porro.",
  "currentTab": "Sharing",
  "reportColumns": [
    {
      "columnName": "sourceType",
      "order": 1
    }
  ],
  "reportFilters": [
    {
      "filterKey": "sectionId",
      "filterValue": "{\"ids\": [\"12345\"]}"
    }
  ]
}
'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:31.061Z",
  "message": "Success",
  "data": {
    "id": "36465d55-4c47-4a35-bbf0-6357b07d1114",
    "reportId": "10001",
    "reportName": "Boehm LLC Status Report",
    "reportType": "DECISIONS",
    "tenantId": "c606f480-aa81-4a05-af46-6b98edd4e18d",
    "ownerId": "369963fb-6258-4f31-af09-48a8982309f7",
    "createdAt": "2025-06-23T09:10:07.573Z",
    "updatedAt": "2025-06-24T07:32:42.149Z",
    "status": "PUBLISHED",
    "reportColumns": [
      {
        "columnName": "sourceType",
        "order": 1
      }
    ],
    "reportFilters": [
      {
        "filterKey": "sectionId",
        "filterValue": "{\"ids\": [\"12345\"]}"
      }
    ],
    "description": "Accusamus in aggero adnuo subseco stips stips.",
    "link": "/reports/view/base64",
    "ownerDetails": {
      "id": "c4d84ffa-cf92-4569-9fe6-e18cd9762790",
      "email": "[email protected]",
      "name": "Clay Kshlerin",
      "firstName": "Emmitt",
      "lastName": "Johnston",
      "mobilePhone": "500-353-7995",
      "isActive": true,
      "profileImageUrl": "https://cdn.jsdelivr.net/gh/faker-js/assets-person-portrait/male/512/17.jpg",
      "positions": [
        {
          "id": "4b321b71-9bf0-42fe-af47-b4f66497769a",
          "positionName": "System Administrator",
          "autoProvisioned": true
        }
      ]
    },
    "currentTab": "Sharing",
    "createdBy": "2d981610-22bc-436e-9b57-a1af02662ca7",
    "updatedBy": "adea9375-26fc-4587-b1f9-e5fec7c2f9ec",
    "permissions": [
      {
        "relationship_key": "<string>",
        "allowed": true
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
reportName
string
required

Report name

Example:

"Cronin, Sauer and Mraz Status Report"

​
reportType
enum<string>
required

Report type

Available options:
DECISIONS,
DELEGATIONS,
ACTIONS,
DOCUMENTS,
USERS,
POSITIONS,
GROUPS,
MATRICES
Example:

"DECISIONS"

​
status
enum<string>
required

Report status

Available options:
PUBLISHED,
ARCHIVED,
DELETED,
DRAFT
Example:

"PUBLISHED"

​
tenantId
string<uuid>
required

Tenant ID

Example:

"ce5e0e52-d47d-4a56-9f31-5546a60e05b8"

​
ownerId
string<uuid>
required

Owner ID

Example:

"61e12e68-9391-42a8-b9ea-2c7f51b3c960"

​
description
string

Report description

Example:

"Tenus creber tantum nihil porro."

​
currentTab
string

Current tab in create matrix flow

Example:

"Sharing"

​
reportColumns
object[]

Report columns

​
reportFilters
object[]

Report filters

Response

201 - application/json

Report created successfully

​
statusCode
number
required

HTTP Status code

Example:

200

​
timestamp
string
required

Timestamp of the response

Example:

"2025-06-24T08:51:31.061Z"

​
message
string
required

Response message

Example:

"Success"

​
data
object
required

Response data