Postal Developers
Use cases

Reporting

Weekly digests, leaderboards and partner reporting.

Weekly digest for an artist or label

Every Monday:

  1. GET /analytics/dashboard for the headline numbers and the dominant genre and mood.
  2. GET /analytics/top?metric=plays&since=<7 days ago> and again for downloads.
  3. Post the result to Slack, email, or a sheet.

Scope: read:analytics.

Per-release performance

For a release with a known set of track ids, call GET /analytics/stats?entity=track&ids=… with since set to the release date. Up to 50 ids per call.

Where a track went

Combine GET /tracks/submissions with the stats above to see whether a pitch turned into listens.

Partner platform reporting

Partners that run file requests on Postal get a platform key and can pull:

  • every file request with free and paid submission counts,
  • per-request submission lists with a stable, anonymised submitter id,
  • accounts acquired through each request.

Platform keys are read-only and issued by Postal.

Notes

  • Engagement comes from the activity log and updates within seconds of the event.
  • Date ranges are inclusive and in UTC.
  • The dashboard's "this week" is the current calendar week, not a rolling 7 days.

On this page