Create Report

Create a new report.

    This endpoint allows you to create a new report configuration.
    The report can then be used to generate instances with data injection.
    
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Serializer for Report model with organization-specific enabled field.

Fields

  • id: HashID of the report
  • name: Report name
  • description: Report description
  • enabled: Boolean indicating if the report is enabled for the user's organization
  • labels: List of labels for filtering and organizing reports
  • sort_priority: Priority for sorting reports (lower values appear first)

Enabled Field Logic

The enabled field shows whether this report is enabled for the authenticated user's organization:

  • True: OrganizationReportLink exists between the report and user's organization
  • False: No OrganizationReportLink exists (report is disabled for the organization)

This applies to both public reports and reports owned by the organization. Even owned reports must be explicitly enabled via OrganizationReportLink.

string
required
length ≤ 255

The name of the report

string | null

Description of the report

labels
array of strings

Labels for filtering and organizing reports (max 55 chars, letters, numbers, spaces, and dashes only)

labels
integer
-2147483648 to 2147483647

Lower values appear first in lists (0 at top)

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json