Posttar API

Reports

2 endpoints for reports, with parameters and a real response example.

GET/projects/{id}/reports/summary

Get a period summary

How many posts the project has published, scheduled, and in draft, optionally within a period. Also reports how many published posts were never measured, which is absence of measurement, not zero views.

ParameterInTypeDescription
idrequiredpathstringOpaque id from a previous response.
fromquerystring
toquerystring

Response

{
  "period": {
    "from": null,
    "to": null
  },
  "published": 0,
  "scheduled": 0,
  "drafts": 21,
  "publishedWithoutMetrics": 0,
  "publishedWithoutDate": 0
}
GET/projects/{id}/reports/performance

Get posts' performance

Published posts with each one's numbers, in two lists that are never mixed: measured ones with real views, likes, and comments, and unmeasured ones Posttar never measured (their views are null, which is not the same as zero).

ParameterInTypeDescription
idrequiredpathstringOpaque id from a previous response.
fromquerystring
toquerystring
limitqueryintegerDefault 20, max 100.

Response

{
  "period": {
    "from": null,
    "to": null
  },
  "measured": [],
  "totalMeasured": 0,
  "withoutMetrics": [],
  "totalWithoutMetrics": 0,
  "totals": null
}