Subrite statistics

GET/api/v1/stats/stats

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleStatsDTO

9 top-level fieldsSelect an object to expand

totalActiveSubcriptionsnumberRequired
totalActivePaidSubcriptionsnumberRequired
totalActiveMembersnumberRequired
totalActivePaidMembersnumberRequired
totalRegisteredMembersnumberRequired
totalLoginYesterdaynumberRequired
totalWaitingForActivationSubscriptionsnumberRequired
totalRecurringRevenueTotalRecurringRevenueDTORequired4 fields
totalRecurringRevenue
- recurringMrrnumberRequiredField path: totalRecurringRevenue.recurringMrr
- recurringArrnumberRequiredField path: totalRecurringRevenue.recurringArr
- estimatedMrrnumberRequiredField path: totalRecurringRevenue.estimatedMrr
- estimatedArrnumberRequiredField path: totalRecurringRevenue.estimatedArr
totalChurnTotalChurnDTORequired3 fields
totalChurn
- totalChurnnumberRequiredField path: totalChurn.totalChurn
  Can be null
- totalChurnPeriodLabelstringRequiredField path: totalChurn.totalChurnPeriodLabel
- totalChurnYearnumberRequiredField path: totalChurn.totalChurnYear

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

Schema ExampleStatsDTO

200 · application/json

{
  "totalActiveSubcriptions": 0,
  "totalActivePaidSubcriptions": 0,
  "totalActiveMembers": 0,
  "totalActivePaidMembers": 0,
  "totalRegisteredMembers": 0,
  "totalLoginYesterday": 0,
  "totalWaitingForActivationSubscriptions": 0,
  "totalRecurringRevenue": {
    "recurringMrr": 0,
    "recurringArr": 0,
    "estimatedMrr": 0,
    "estimatedArr": 0
  },
  "totalChurn": {
    "totalChurn": 0,
    "totalChurnPeriodLabel": "string",
    "totalChurnYear": 0
  }
}

Example · 20 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

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

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

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

Try it

GET/api/v1/stats/total-stats

Authentication: Bearer token (JWT)

Parameters

Query parameters1

daysnumberRequired

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleStatsForNthDaysDTO

5 top-level fields

totalNewPaidSubscriptionsnumberRequired
totalPaidRenewalsnumberRequired
totalCanceledPaidSubscriptionsnumberRequired
totalStoppedPaidSubscriptionsnumberRequired
totalReactivatedSubscriptionsnumberRequired

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

Schema ExampleStatsForNthDaysDTO

200 · application/json

{
  "totalNewPaidSubscriptions": 0,
  "totalPaidRenewals": 0,
  "totalCanceledPaidSubscriptions": 0,
  "totalStoppedPaidSubscriptions": 0,
  "totalReactivatedSubscriptions": 0
}

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

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

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/stats/total-stats?days=%3Cdays%3E' \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/feeds

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"
filterFilteredActivityLogActionOptional
Field details
Allowed values: "initial_purchase", "subscription_renewed", "auto_renewal_turned_off", "auto_renewal_turned_on", "subscription_expired", "payment_failed", "subscription_deactivated", "subscription_inactive", "subscription_reactivated", "subscription_stopped", "next_renewal_updated", "recurring_price_updated", "activation_date_updated", "subscription_activated", "subscription_canceled_before_activation", "update_member_profile", "update_consent", "login", "change_initiated", "change_completed", "change_cancelled", "seat_invitation_sent", "seat_invitation_removed", "seat_invitation_accepted", "seat_member_added", "group_owner_access_enabled", "group_owner_access_disabled", "seat_gift_receiver_added", "seat_gift_receiver_removed", "seat_gift_receiver_accepted", "seat_gift_receiver_invitation_sent", "invoice_sent", "payment_method_updated", "payment_method_removed", "payment_provider_updated", "invoice_address_updated", "delivery_address_updated", "credit_note_created", "refund_registered", "payment_registered", "vipps_recurring_charge_initiated", "ledger_matched", "ledger_unmatched", "ledger_transaction_ignored", "signup"
excludestringOptional

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleActivityLogResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of ActivityLogResponseRequired6 fields
items
- actionActivityLogActionRequired when parent is presentField path: items[].action
  Field details
  Allowed values: "initial_purchase", "subscription_renewed", "auto_renewal_turned_off", "auto_renewal_turned_on", "subscription_expired", "payment_failed", "subscription_activated", "subscription_deactivated", "subscription_inactive", "subscription_reactivated", "subscription_stopped", "subscription_canceled_before_activation", "activation_date_updated", "next_renewal_updated", "recurring_price_updated", "change_initiated", "change_completed", "change_cancelled", "seat_invitation_sent", "seat_invitation_removed", "seat_invitation_accepted", "seat_member_added", "group_owner_access_enabled", "group_owner_access_disabled", "seat_gift_receiver_added", "seat_gift_receiver_removed", "seat_gift_receiver_accepted", "seat_gift_receiver_invitation_sent", "invoice_sent", "payment_method_updated", "payment_method_removed", "payment_provider_updated", "invoice_address_updated", "delivery_address_updated", "credit_note_created", "refund_registered", "payment_registered", "vipps_recurring_charge_initiated", "ledger_matched", "ledger_unmatched", "ledger_transaction_ignored", "update_member_profile", "update_consent", "login", "signup", "gdpr_deleted"
- feedobjectRequired when parent is presentField path: items[].feed
- createdAtstring (date-time)Required when parent is presentField path: items[].createdAt
- memberIdstringRequired when parent is presentField path: items[].memberId
- memberNumbernumberRequired when parent is presentField path: items[].memberNumber
- idnumberRequired when parent is presentField path: items[].id
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExampleActivityLogResponsePaginated

200 · application/json

{
  "items": [
    {
      "feed": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 15 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

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

Try it

GET/api/v1/stats/referrer-stats

Authentication: Bearer token (JWT)

Parameters

Query parameters7

daysnumberOptional
dateFromstringOptional
dateTostringOptional
pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "count"Allowed values: "count"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleReferrerStatsDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of ReferrerStatsDtoRequired3 fields
items
- referrerstringRequired when parent is presentField path: items[].referrer
- countnumberRequired when parent is presentField path: items[].count
- lastPurchasedAtstring (date-time)Required when parent is presentField path: items[].lastPurchasedAt
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExampleReferrerStatsDtoPaginated

200 · application/json

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

Example · 13 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get all stats for nth days (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

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

Try it

GET/api/v1/stats/export/referrer-stats

Authentication: Bearer token (JWT)

Parameters

Query parameters3

dateFromstring (date-time)Optional
dateTostring (date-time)Optional
fileFormatstringOptional

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/export/referrer-stats \
  --header 'Authorization: Bearer <token>'

Try it

Run subscription summary job for all tenants#

POST/api/v1/stats/cron/subscription-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

1 top-level field

tenantIdsarray of numberOptional
Default: []

1 documented field · Scroll to see moreShow full heightShow compact view

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/subscription-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

Run product summary job for all tenants#

POST/api/v1/stats/cron/product-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/product-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

Run member summary job for all tenants#

POST/api/v1/stats/cron/member-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/member-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

Run subscription activity summary job for all tenants#

POST/api/v1/stats/cron/subscription-activity-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsCronDTO

2 top-level fields

tenantIdsarray of numberOptional
Default: []
dataDatestring (date-time)Optional

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

Schema ExampleStatsCronDTO

application/json

{
  "tenantIds": [],
  "dataDate": "yyyy-MM-dd"
}

Example · 4 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/subscription-activity-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": [],
  "dataDate": "yyyy-MM-dd"
}'

Try it

Run recurring revenue job for all tenants#

POST/api/v1/stats/cron/recurring-revenue

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/recurring-revenue \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

POST/api/v1/stats/cron/consent-activity-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Responses

4 status codes

Responses 201

Responses 401

Status201 401 403 500application/json

unauthorized

Responses 403

Status201 401 403 500application/json

forbiddenResource

Responses 500

Status201 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/consent-activity-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": [],
  "dataDate": "yyyy-MM-dd"
}'

Try it

POST/api/v1/stats/cron/consent-channel-activity-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Responses

4 status codes

Responses 201

Responses 401

Status201 401 403 500application/json

unauthorized

Responses 403

Status201 401 403 500application/json

forbiddenResource

Responses 500

Status201 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/consent-channel-activity-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": [],
  "dataDate": "yyyy-MM-dd"
}'

Try it

Run podcast access summary job for all tenants#

POST/api/v1/stats/cron/podcast-access-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsCronDTO

Same fields as Run subscription activity summary job for all tenants (Request body).

Schema ExampleStatsCronDTO

application/json

{
  "tenantIds": [],
  "dataDate": "yyyy-MM-dd"
}

Example · 4 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/podcast-access-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": [],
  "dataDate": "yyyy-MM-dd"
}'

Try it

Run Spotify user summary job for all tenants#

POST/api/v1/stats/cron/spotify-user-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/spotify-user-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

GET/api/v1/stats/historical-subscriptions

Authentication: Bearer token (JWT)

Parameters

Query parameters6

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/
typeSubscriptionTypeOptional
Allowed values: "all", "free", "paid"
groupByGroupByTypeOptional
Allowed values: "subscriptionPlan", "package", "paymentProvider"
noOfLineNoOfLineOptional
Allowed values: 3, 4, 5, 7, 100

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleHistoricalTimelineStatsResDto

2 top-level fieldsSelect an object to expand

dataarray of HistoricalStatsDataRequired3 fields
data
- labelnumberRequired when parent is presentField path: data[].label
- entitiesarray of StatsGraphDataRequired when parent is presentField path: data[].entities4 fields
  data[].entities
  - idnumberRequired when parent is presentField path: data[].entities[].id
  - namestringRequired when parent is presentField path: data[].entities[].name
  - countnumberRequired when parent is presentField path: data[].entities[].count
  - additionalDatanumberField path: data[].entities[].additionalData
- yearnumberRequired when parent is presentField path: data[].year
periodTimelineGranularityRequired
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"

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

Schema ExampleHistoricalTimelineStatsResDto

200 · application/json

{
  "data": [
    {
      "entities": []
    }
  ],
  "period": "daily"
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-subscriptions \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-products

Authentication: Bearer token (JWT)

Parameters

Query parameters5

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/
typeProductTypeOptional
Allowed values: "all", "free", "paid"
noOfLineNoOfLineOptional
Allowed values: 3, 4, 5, 7, 100

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleHistoricalTimelineStatsResDto

Same fields as Get historical subscriptions (200).

Schema ExampleHistoricalTimelineStatsResDto

200 · application/json

{
  "data": [
    {
      "entities": []
    }
  ],
  "period": "daily"
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-products \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-members

Authentication: Bearer token (JWT)

Parameters

Query parameters4

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/
typeMemberTypeOptional
Allowed values: "all", "paid"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleHistoricalTimelineStatsResDto

Same fields as Get historical subscriptions (200).

Schema ExampleHistoricalTimelineStatsResDto

200 · application/json

{
  "data": [
    {
      "entities": []
    }
  ],
  "period": "daily"
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-members \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-current-revenue

Each bucket carries two series — recurring (auto-renew on) and expiring (auto-renew off). Buckets after the current period are projected from active subscriptions and capped 12 months ahead. Every bucket carries the same shape whether it was measured or projected — the split point is the current period — and the plan and package options for the graph filter are served separately by /current-revenue-filter-options.

Authentication: Bearer token (JWT)

Parameters

Query parameters6

estimationRevenuePeriodOptional
Allowed values: "monthly", "quarterly", "yearly"
periodTimelineGranularityOptional
Bucket granularity. Daily is not accepted here: this graph projects forward, and a per-day projection would walk up to 365 generate_series buckets across every active subscription — and carries no meaning at that resolution.Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate. May be in the future — periods after the current one are projected from active subscriptions, capped at 12 months ahead.pattern: /^\d{4}-\d{2}-\d{2}$/
subscriptionPlanIdnumberOptional
Limit the graph to a single subscription plan. Omit for all plans.minimum: 1
packageIdnumberOptional
Limit the graph to a single product package. Omit for all packages.minimum: 1

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleHistoricalTimelineStatsResDto

Same fields as Get historical subscriptions (200).

Schema ExampleHistoricalTimelineStatsResDto

200 · application/json

{
  "data": [
    {
      "entities": []
    }
  ],
  "period": "daily"
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-current-revenue \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/current-revenue-filter-options

All-time options, independent of the graph window. The two lists co-filter each other from the selection passed in: subscriptionPlanId narrows the packages to those observed with that plan, packageId narrows the plans the same way, and neither list is narrowed by its own selection — so every option offered draws a chart with data in it, and the current choice can always be changed. Pass the graph filter as it stands and re-fetch when it changes; omit both for every option the tenant has. The pairs come from the snapshots the graph itself renders, so a package that has carried several plans over its life keeps all of them. Served under the dashboard permission so an admin without plans-and-products access can still filter the graph. Not paged, because each list fills one dropdown: at most 500 plans and the same number of packages are returned, so a tenant with a very long product history cannot produce an unbounded response. Both lists are ordered by revenue in the most recent snapshot, largest first, with name breaking ties; options no longer sold rank last.

Authentication: Bearer token (JWT)

Parameters

Query parameters2

subscriptionPlanIdnumberOptional
The plan currently selected in the graph filter. Narrows the package options to the packages observed with that plan; the plan options themselves stay complete.minimum: 1
packageIdnumberOptional
The package currently selected in the graph filter. Narrows the plan options to the plans observed with that package; the package options themselves stay complete.minimum: 1

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleCurrentRevenueFilterOptionsResDto

200 · application/json

{
  "availablePlans": [
    {}
  ],
  "availablePackages": [
    {}
  ]
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

Responses 403

Status200 401 403 500application/json

forbiddenResource

Responses 500

Status200 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/current-revenue-filter-options \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/timeline-extent

Authentication: Bearer token (JWT)

Parameters

Query parameters1

graphTimelineGraphRequired
Field details
Which stats graph to report the earliest available data date for.Allowed values: "subscriptions", "currentRevenue", "members", "products", "consents", "consentChanges", "consentSource", "subscriptionActivity", "podcastUsers"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleTimelineExtentResDto

1 top-level field

earliestDatestring
Can be nullEarliest date (yyyy-MM-dd) for which this graph has data, or null when the graph has no data yet.

1 documented field · Scroll to see moreShow full heightShow compact view

Schema ExampleTimelineExtentResDto

200 · application/json

{
  "earliestDate": "2021-03-15"
}

Example · 3 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/stats/timeline-extent?graph=subscriptions' \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-subscriptions-activity

Authentication: Bearer token (JWT)

Parameters

Query parameters3

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleHistoricalTimelineStatsResDto

Same fields as Get historical subscriptions (200).

Schema ExampleHistoricalTimelineStatsResDto

200 · application/json

{
  "data": [
    {
      "entities": []
    }
  ],
  "period": "daily"
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-subscriptions-activity \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-churn-rates

Authentication: Bearer token (JWT)

Parameters

Query parameters5

periodDataSelectionPeriodOptional
Allowed values: "weekly", "monthly"
typeChurnTypeOptional
Allowed values: "gross", "net"
groupByGroupByTypeOptional
Allowed values: "subscriptionPlan", "package", "paymentProvider"
subscriptionTypeSubscriptionTypeOptional
Allowed values: "all", "free", "paid"
noOfLineNoOfLineOptional
Allowed values: 3, 4, 5, 7, 100

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleHistoricalChurnRateResDto

2 top-level fieldsSelect an object to expand

detailsChurnHistoricalStatsResDtoRequired2 fields
detailsChurn
- dataarray of HistoricalStatsDataRequiredField path: detailsChurn.data3 fields
  detailsChurn.data
  - labelnumberRequired when parent is presentField path: detailsChurn.data[].label
  - entitiesarray of StatsGraphDataRequired when parent is presentField path: detailsChurn.data[].entitiesNested fields omitted: depth limit.
  - yearnumberRequired when parent is presentField path: detailsChurn.data[].year
- periodDataSelectionPeriodRequiredField path: detailsChurn.period
  Allowed values: "weekly", "monthly"
totalChurnHistoricalStatsResDtoRequired2 fields
totalChurn
- dataarray of HistoricalStatsDataRequiredField path: totalChurn.data3 fields
  totalChurn.data
  - labelnumberRequired when parent is presentField path: totalChurn.data[].label
  - entitiesarray of StatsGraphDataRequired when parent is presentField path: totalChurn.data[].entitiesNested fields omitted: depth limit.
  - yearnumberRequired when parent is presentField path: totalChurn.data[].year
- periodDataSelectionPeriodRequiredField path: totalChurn.period
  Allowed values: "weekly", "monthly"

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

Schema ExampleHistoricalChurnRateResDto

200 · application/json

{
  "detailsChurn": {
    "data": [],
    "period": "weekly"
  },
  "totalChurn": {
    "data": [],
    "period": "weekly"
  }
}

Example · 10 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-churn-rates \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-consent-activity

Authentication: Bearer token (JWT)

Parameters

Query parameters4

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/
consentIdsarray of numberOptional
Array of consent IDs to filter by

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Responses 401

unauthorized

Responses 403

Status200 401 403 500application/json

forbiddenResource

Responses 500

Status200 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-consent-activity \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-consent-summary

Authentication: Bearer token (JWT)

Parameters

Query parameters5

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/
statusMemberConsentStatusOptional
Allowed values: "accepted", "withdrawn"
noOfLineNoOfLineOptional
Allowed values: 3, 4, 5, 7, 100

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Responses 401

unauthorized

Responses 403

Status200 401 403 500application/json

forbiddenResource

Responses 500

Status200 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-consent-summary \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/historical-consent-channel-summary

Authentication: Bearer token (JWT)

Parameters

Query parameters6

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/
typeMemberConsentStatusOptional
Allowed values: "accepted", "withdrawn"
consentIdsarray of numberOptional
Array of consent IDs to filter by
noOfLineNoOfLineOptional
Allowed values: 3, 4, 5, 7, 100

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Responses 401

unauthorized

Responses 403

Status200 401 403 500application/json

forbiddenResource

Responses 500

Status200 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/historical-consent-channel-summary \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/subscription-ended-by-reason

Authentication: Bearer token (JWT)

Parameters

Query parameters1

filterSubscriptionEndedFilterOptional
Allowed values: "yesterday", "last_7_days", "last_30_days", "last_year"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleSubscriptionEndedByReasonResDto

1 top-level fieldSelect an object to expand

dataarray of SubscriptionEndedByReasonDataRequired2 fields
data
- reasonstringRequired when parent is presentField path: data[].reason
- quantitynumberRequired when parent is presentField path: data[].quantity

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

Schema ExampleSubscriptionEndedByReasonResDto

200 · application/json

{
  "data": [
    {}
  ]
}

Example · 5 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/subscription-ended-by-reason \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/payment-method-stats

Authentication: Bearer token (JWT)

Parameters

Query parameters1

viewTypePaymentMethodViewTypeOptional
Allowed values: "quantity", "share_and_churn"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExamplePaymentMethodStatsResDto

1 top-level fieldSelect an object to expand

dataarray of PaymentMethodDataRequired4 fields
data
- paymentProviderstringRequired when parent is presentField path: data[].paymentProvider
- quantitynumberRequired when parent is presentField path: data[].quantity
- sharenumberField path: data[].share
- churnRatenumberField path: data[].churnRate

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

Schema ExamplePaymentMethodStatsResDto

200 · application/json

{
  "data": [
    {}
  ]
}

Example · 5 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/payment-method-stats \
  --header 'Authorization: Bearer <token>'

Try it

Get podcast users summary (Spotify + other apps, stacked)#

GET/api/v1/stats/podcast-users-summary

Authentication: Bearer token (JWT)

Parameters

Query parameters4

periodTimelineGranularityOptional
Allowed values: "daily", "weekly", "monthly", "quarterly", "yearly"
fromDatestringOptional
Start of custom date range (yyyy-MM-dd). Requires toDate.pattern: /^\d{4}-\d{2}-\d{2}$/
toDatestringOptional
End of custom date range (yyyy-MM-dd). Requires fromDate.pattern: /^\d{4}-\d{2}-\d{2}$/
subscriptionStatusSUBSCRIPTION_STATUSOptional
Allowed values: "all", "active"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleHistoricalTimelineStatsResDto

Same fields as Get historical subscriptions (200).

Schema ExampleHistoricalTimelineStatsResDto

200 · application/json

{
  "data": [
    {
      "entities": []
    }
  ],
  "period": "daily"
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/podcast-users-summary \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/podcast-download-stats

Returns download counts for 1 day, 7 days, 30 days, all time, hourly breakdown, and episode breakdown

Authentication: Bearer token (JWT)

Parameters

Query parameters6

datestringOptional
Specific date to get stats for (defaults to today)
podcastIdnumberOptional
Filter by specific podcast ID
fromDatestringOptional
Date range start for time-series chart
toDatestringOptional
Date range end for time-series chart
periodstringOptional
Default: "daily"Aggregation period for time-series chartAllowed values: "daily", "weekly", "monthly"
episodeIdstringOptional
Filter by specific episode ID

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExamplePodcastDownloadStatsResDto

4 top-level fieldsSelect an object to expand

summarySummaryCardsDtoRequired4 fields
summary
Summary statistics
- last1DaynumberRequiredField path: summary.last1Day
  Downloads in the last 24 hours
- last7DaysnumberRequiredField path: summary.last7Days
  Downloads in the last 7 days
- last30DaysnumberRequiredField path: summary.last30Days
  Downloads in the last 30 days
- allTimenumberRequiredField path: summary.allTime
  All time downloads
todayHourlyDownloadsarray of HourlyDownloadDtoRequired2 fields
todayHourlyDownloads
Hourly downloads for today
- hournumberRequired when parent is presentField path: todayHourlyDownloads[].hour
  Hour of day (0-23)
- countnumberRequired when parent is presentField path: todayHourlyDownloads[].count
  Download count for this hour
episodeTablearray of EpisodeDownloadDtoRequired7 fields
episodeTable
Episode breakdown (based on fromDate/toDate if provided, otherwise last 30 days)
- episodeIdstringRequired when parent is presentField path: episodeTable[].episodeId
  Episode ID (hash from Signal)
- episodeNamestringField path: episodeTable[].episodeName
  Episode name from RSS feed
- podcastIdstringRequired when parent is presentField path: episodeTable[].podcastId
  Podcast ID
- podcastNamestringField path: episodeTable[].podcastName
  Podcast name
- publishedDatestring (date-time)Field path: episodeTable[].publishedDate
  Episode published date from RSS feed
- totalDownloadsnumberRequired when parent is presentField path: episodeTable[].totalDownloads
  Total downloads for this episode
- percentageOfTotalnumberRequired when parent is presentField path: episodeTable[].percentageOfTotal
  Percentage of total downloads
timeSeriesDataarray of TimeSeriesDataPointDtoRequired2 fields
timeSeriesData
Time-series data for chart (based on fromDate, toDate, period parameters)
- datestringRequired when parent is presentField path: timeSeriesData[].date
  Date or period identifier (ISO date, YYYY-WW, or YYYY-MM)
- countnumberRequired when parent is presentField path: timeSeriesData[].count
  Download count for this period

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

Schema ExamplePodcastDownloadStatsResDto

200 · application/json

{
  "summary": {
    "last1Day": 0,
    "last7Days": 0,
    "last30Days": 0,
    "allTime": 0
  },
  "todayHourlyDownloads": [
    {}
  ],
  "episodeTable": [
    {}
  ],
  "timeSeriesData": [
    {}
  ]
}

Example · 17 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/podcast-download-stats \
  --header 'Authorization: Bearer <token>'

Try it

Run podcast download summary job for all tenants#

POST/api/v1/stats/cron/podcast-download-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/podcast-download-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

Re-aggregate podcast download summaries for a tenant over a UTC day range#

POST/api/v1/stats/backfill/podcast-download-summary

Re-runs the hourly aggregation with the current deduplication logic and overwrites existing hourly counts. Use to repair historical rows (e.g. inflated counts). Does not move the regular hourly cron checkpoint.

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExamplePodcastDownloadBackfillDTO

3 top-level fields

tenantIdnumberRequired
Tenant to re-aggregate
fromDatestringRequired
First UTC day to re-aggregate (inclusive)
toDatestringRequired
Last UTC day to re-aggregate (inclusive)

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

Schema ExamplePodcastDownloadBackfillDTO

application/json

{
  "tenantId": 32,
  "fromDate": "2026-05-20",
  "toDate": "2026-05-21"
}

Example · 5 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/backfill/podcast-download-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": 32,
  "fromDate": "2026-05-20",
  "toDate": "2026-05-21"
}'

Try it

GET/api/v1/stats/checkout-funnel-stats

Returns funnel stage counts, conversion rates, and comparison data for checkout flow

Authentication: Bearer token (JWT)

Parameters

Query parameters7

fromDatestringOptional
Date range start
toDatestringOptional
Date range end
packageSlugstringOptional
Filter by single package slug
paymentMethodstringOptional
Filter by single payment method
packageSlugsarray of stringOptional
Package slugs to compare (max 3)maxItems: 3
paymentMethodsarray of stringOptional
Payment methods to compare (max 3)maxItems: 3
viewModestringOptional
Default: "single"View modeAllowed values: "single", "compare-packages", "compare-payments"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleCheckoutFunnelStatsResDto

3 top-level fieldsSelect an object to expand

funnelsarray of FunnelDataDtoRequired6 fields
funnels
Funnel data sets
- idstringRequired when parent is presentField path: funnels[].id
  Identifier (e.g., "all", package slug, payment method)
- namestringRequired when parent is presentField path: funnels[].name
  Display name
- stagesarray of FunnelStageDtoRequired when parent is presentField path: funnels[].stages5 fields
  funnels[].stages
  Funnel stages
  - namestringRequired when parent is presentField path: funnels[].stages[].name
    Funnel stage name
  - countnumberRequired when parent is presentField path: funnels[].stages[].count
    Event count for this stage
  - percentagenumberRequired when parent is presentField path: funnels[].stages[].percentage
    Percentage relative to the first stage (checkout_loaded)
  - dropnumberField path: funnels[].stages[].drop
    Drop-off count from previous stage
  - dropPercentnumberField path: funnels[].stages[].dropPercent
    Drop-off percentage from previous stage
- conversionRatenumberRequired when parent is presentField path: funnels[].conversionRate
  Overall conversion rate (purchases / checkout loaded) as percentage
- previousConversionRatenumberField path: funnels[].previousConversionRate
  Previous period conversion rate
- changenumberField path: funnels[].change
  Change vs previous period (percentage points)
availablePackagesarray of stringRequired
Available package slugs for filtering
availablePaymentMethodsarray of stringRequired
Available payment methods for filtering

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

Schema ExampleCheckoutFunnelStatsResDto

200 · application/json

{
  "funnels": [
    {
      "stages": []
    }
  ],
  "availablePackages": [
    "string"
  ],
  "availablePaymentMethods": [
    "string"
  ]
}

Example · 13 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/checkout-funnel-stats \
  --header 'Authorization: Bearer <token>'

Try it

Run checkout funnel summary job for all tenants#

POST/api/v1/stats/cron/checkout-funnel-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/checkout-funnel-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

GET/api/v1/stats/customer-economics

Authentication: Bearer token (JWT)

Parameters

Query parameters1

datestring (date-time)Optional
Optional date parameter

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleCustomerEconomicsResponseDTO

4 top-level fields

arpunumberRequired
churn3mnumberRequired
lifetimeValuenumberRequired
lifetimeLengthnumberRequired

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

Schema ExampleCustomerEconomicsResponseDTO

200 · application/json

{
  "arpu": 0,
  "churn3m": 0,
  "lifetimeValue": 0,
  "lifetimeLength": 0
}

Example · 6 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/customer-economics \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/accumulated-payment-flow

Authentication: Bearer token (JWT)

Parameters

Query parameters2

yearnumberOptional
Year to query (optional, defaults to current year)minimum: 2000maximum: 2100
monthnumberOptional
Month to query (1-12, optional, defaults to current month)minimum: 1maximum: 12

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExamplePaymentFlowResDto

2 top-level fieldsSelect an object to expand

currentMonthMonthlyPaymentFlowDataRequired3 fields
currentMonth
Current month payment flow data
- yearnumberRequiredField path: currentMonth.year
  Year
- monthnumberRequiredField path: currentMonth.month
  Month (1-12)
- daysarray of DailyPaymentDataRequiredField path: currentMonth.days2 fields
  currentMonth.days
  Daily accumulated payment data
  - daynumberRequired when parent is presentField path: currentMonth.days[].day
    Day of the month
  - accumulatedAmountnumberRequired when parent is presentField path: currentMonth.days[].accumulatedAmount
    Accumulated payment amount up to this day
previousMonthMonthlyPaymentFlowDataRequired3 fields
previousMonth
Previous month payment flow data
- yearnumberRequiredField path: previousMonth.year
  Year
- monthnumberRequiredField path: previousMonth.month
  Month (1-12)
- daysarray of DailyPaymentDataRequiredField path: previousMonth.days2 fields
  previousMonth.days
  Daily accumulated payment data
  - daynumberRequired when parent is presentField path: previousMonth.days[].day
    Day of the month
  - accumulatedAmountnumberRequired when parent is presentField path: previousMonth.days[].accumulatedAmount
    Accumulated payment amount up to this day

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

Schema ExamplePaymentFlowResDto

200 · application/json

{
  "currentMonth": {
    "year": 2024,
    "month": 12,
    "days": []
  },
  "previousMonth": {
    "year": 2024,
    "month": 12,
    "days": []
  }
}

Example · 12 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/accumulated-payment-flow \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/stats/logged-in-user-stats

Authentication: Bearer token (JWT)

Parameters

Query parameters2

fromDatestringOptional
Date range start
toDatestringOptional
Date range end

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleLoggedInUserStatsResDto

2 top-level fields

totalLoggedInnumberRequired
Total unique logged-in users for the period
withSubscriptionnumberRequired
Unique logged-in users with active subscription

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

Schema ExampleLoggedInUserStatsResDto

200 · application/json

{
  "totalLoggedIn": 0,
  "withSubscription": 0
}

Example · 4 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/logged-in-user-stats \
  --header 'Authorization: Bearer <token>'

Try it

Run logged-in users summary job for all tenants#

POST/api/v1/stats/cron/logged-in-users-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/logged-in-users-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

Get content type visit statistics for a date range#

GET/api/v1/stats/content-type-visit-stats

Authentication: Bearer token (JWT)

Parameters

Query parameters2

fromDatestringOptional
Date range start
toDatestringOptional
Date range end

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleContentTypeVisitStatsResDto

1 top-level fieldSelect an object to expand

dataPointsarray of ContentTypeVisitDataPointDtoRequired4 fields
dataPoints
Data points per date per content type
- datestringRequired when parent is presentField path: dataPoints[].date
  Date in YYYY-MM-DD format
- contentTypestringRequired when parent is presentField path: dataPoints[].contentType
  Content type (website, podcast, mypage)
- deviceTypestringRequired when parent is presentField path: dataPoints[].deviceType
  Device type (desktop, mobile, or empty string)
- countnumberRequired when parent is presentField path: dataPoints[].count
  Unique visit count

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

Schema ExampleContentTypeVisitStatsResDto

200 · application/json

{
  "dataPoints": [
    {}
  ]
}

Example · 5 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/content-type-visit-stats \
  --header 'Authorization: Bearer <token>'

Try it

Run content type visit summary job for all tenants#

POST/api/v1/stats/cron/content-type-visit-summary

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleStatsTenantIdsDTO

Same fields as Run subscription summary job for all tenants (Request body).

Schema ExampleStatsTenantIdsDTO

application/json

{
  "tenantIds": []
}

Example · 3 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get basic stats (403).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get basic stats (403).

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get basic stats (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/stats/cron/content-type-visit-summary \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantIds": []
}'

Try it

Get basic stats#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Get all stats for nth days#

Parameters

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Get all activity feeds for admin#

Parameters

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Get all sales grouped by referrer for nth days or date range#

Parameters

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Export all sales by referrer nth days#

Parameters

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Run subscription summary job for all tenants#

Request body

Responses

Responses 201

Responses 401

Responses 403

Responses 500

Run product summary job for all tenants#

Request body

Responses

Responses 201

Responses 401

Responses 403

Responses 500

Run member summary job for all tenants#

Request body

Responses

Responses 201

Responses 401

Responses 403

Responses 500

Run subscription activity summary job for all tenants#

Request body

Responses

Responses 201

Responses 401

Responses 403

Responses 500

Run recurring revenue job for all tenants#

Request body

Responses

Responses 201

Responses 401

Responses 403

Responses 500

Run consent activity summary job for all tenants#

Request body

Responses

Responses 201

Responses 401

Responses 403

Responses 500

Run consent channel activity summary job for all tenants#

Request body