Automated Reports | Subrite

Automated Reports

Endpoints for Automated Reports

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/automated-reports

Authentication: Bearer token (JWT)

Parameters

Query parameters6

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"
statusstringOptional
Allowed values: "active", "draft"
frequencystringOptional
Allowed values: "monthly", "weekly", "daily"

Responses

2 status codes

Responses 200

Status200 401application/json

Schema ExampleAutomatedReportResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of AutomatedReportResponseDtoRequired16 fields
items
- idstringRequired when parent is presentField path: items[].id
- namestringRequired when parent is presentField path: items[].name

Example requestcurl

curl

curl https://api.subrite.no/api/v1/automated-reports \
  --header 'Authorization: Bearer <token>'

Try it

Create a new automated report#

POST/api/v1/automated-reports

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateAutomatedReportDto

8 top-level fields

namestringRequired
Name of the report
statusstringOptional
Default: "draft"Allowed values: "active", "draft"
frequency

GET/api/v1/automated-reports/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

3 status codes

Responses 200

Status200 401 404application/json

Schema ExampleAutomatedReportResponseDto

Same fields as Create a new automated report (201).

PUT/api/v1/automated-reports/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateAutomatedReportDto

8 top-level fields

namestringOptional
Name of the report
status

DELETE/api/v1/automated-reports/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

3 status codes

Responses 204

Report deleted

This response has no body.

Responses 401

Schema ExampleAutomatedReportResponseDtoPaginated

200 · application/json

{
  "items": [
    {
      "schedule": {},
      "recipientUserIds": [],
      "externalEmails": [],
      "selectedSections": []
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 18 linesShow full heightShow compact view

string

Schema ExampleCreateAutomatedReportDto

application/json

{
  "name": "string",
  "status": "active",
  "frequency": "monthly",
  "sendTime": "09:00",
  "recipientUserIds": [
    "string"
  ],
  "externalEmails": [
    "user@example.com"
  ],
  "selectedSections": [
    "sales_statistics"
  ],
  "includeDashboardLink": true
}

Example · 16 linesShow full heightShow compact view

Responses

3 status codes

Responses 201

Status201 400 401application/json

Schema ExampleAutomatedReportResponseDto

16 top-level fields

idstringRequired
namestringRequired
statusAutomatedReportStatusRequired
Allowed values: "active", "draft"
frequencyAutomatedReportFrequencyRequired
Allowed values: "monthly", "weekly", "daily"
cronExpressionstringRequired
scheduleobject
Can be null
sendTimestringRequired
recipientUserIdsarray of string
Can be null
externalEmailsarray of string
Can be null
selectedSectionsarray of AutomatedReportSectionRequired
Allowed values: "sales_statistics", "sales_by_reference", "mrr", "subscriptions", "cashflow", "consents", "consent_changes"
includeDashboardLinkbooleanRequired
lastSentstring (date-time)
Can be null
nextScheduledAtstring (date-time)
Can be null
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
recipientCountnumberRequired
Total number of recipients (users + external emails)

16 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleAutomatedReportResponseDto

201 · application/json

{
  "id": "string",
  "name": "string",
  "status": "active",
  "frequency": "monthly",
  "cronExpression": "string",
  "schedule": {},
  "sendTime": "string",
  "recipientUserIds": [
    "string"
  ],
  "externalEmails": [
    "string"
  ],
  "selectedSections": [
    "sales_statistics"
  ],
  "includeDashboardLink": true,
  "lastSent": "2019-08-24T14:15:22Z",
  "nextScheduledAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "recipientCount": 0
}

Example · 24 linesShow full heightShow compact view

Responses 400

Status201 400 401application/json

atLeastOneSectionMustBeSelected

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors

Responses 401

unauthorized

This response has no body.

Example requestcurl

curl

curl https://api.subrite.no/api/v1/automated-reports \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "status": "active",
  "frequency": "monthly",
  "sendTime": "09:00",
  "recipientUserIds": [
    "string"
  ],
  "externalEmails": [
    "user@example.com"
  ],
  "selectedSections": [
    "sales_statistics"
  ],
  "includeDashboardLink": true
}'

AutomatedReportResponseDto

200 · application/json

{
  "id": "string",
  "name": "string",
  "status": "active",
  "frequency": "monthly",
  "cronExpression": "string",
  "schedule": {},
  "sendTime": "string",
  "recipientUserIds": [
    "string"
  ],
  "externalEmails": [
    "string"
  ],
  "selectedSections": [
    "sales_statistics"
  ],
  "includeDashboardLink": true,
  "lastSent": "2019-08-24T14:15:22Z",
  "nextScheduledAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "recipientCount": 0
}

Example · 24 linesShow full heightShow compact view

string

Schema ExampleUpdateAutomatedReportDto

application/json

{
  "name": "string",
  "status": "active",
  "frequency": "monthly",
  "sendTime": "09:00",
  "recipientUserIds": [
    "string"
  ],
  "externalEmails": [
    "user@example.com"
  ],
  "selectedSections": [
    "sales_statistics"
  ],
  "includeDashboardLink": true
}

Example · 16 linesShow full heightShow compact view

Responses

3 status codes

Responses 200

Status200 401 404application/json

Schema ExampleAutomatedReportResponseDto

Same fields as Create a new automated report (201).

Schema ExampleAutomatedReportResponseDto

200 · application/json

{
  "id": "string",
  "name": "string",
  "status": "active",
  "frequency": "monthly",
  "cronExpression": "string",
  "schedule": {},
  "sendTime": "string",
  "recipientUserIds": [
    "string"
  ],
  "externalEmails": [
    "string"
  ],
  "selectedSections": [
    "sales_statistics"
  ],
  "includeDashboardLink": true,
  "lastSent": "2019-08-24T14:15:22Z",
  "nextScheduledAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "recipientCount": 0
}

Example · 24 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 404

Report not found

This response has no body.

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/automated-reports/{id}' \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "status": "active",
  "frequency": "monthly",
  "sendTime": "09:00",
  "recipientUserIds": [
    "string"
  ],
  "externalEmails": [
    "user@example.com"
  ],
  "selectedSections": [
    "sales_statistics"
  ],
  "includeDashboardLink": true
}'

Get all automated reports#

Parameters

Responses

Responses 200

Create a new automated report#

Request body

Get automated report by ID#

Parameters

Responses

Responses 200

Update an automated report#

Parameters

Request body

Delete an automated report#

Parameters

Responses

Responses 204

Responses 401

Get all automated reports#

Parameters

Responses

Responses 200

Create a new automated report#

Request body

Get automated report by ID#

Parameters

Responses

Responses 200

Update an automated report#

Parameters

Request body

Delete an automated report#

Parameters

Responses

Responses 204

Responses 401

Responses 401

Responses

Responses 201

Responses 400

Responses 401

Responses 401

Responses 404

Responses

Responses 200

Responses 401

Responses 404

Responses 404