Posts

/posts/{post_id}/analytics

Returns the collected metrics for a published post.

Numbers are collected from the channel on a schedule, so a post published moments ago reports nothing yet. Read collection_status before concluding anything from a zero: it separates "still collecting" from "the account needs reconnecting" and from genuine silence.

A post that never published has no analytics and answers 404.

Requires the analytics:read scope.

get/projects/{project_id}/posts/{post_id}/analytics

Request

  • Base URL: https://api.productbyte.com/v1
  • URL: https://api.productbyte.com/v1/projects/{project_id}/posts/{post_id}/analytics
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project the post belongs to.

post_idstring required

The published post to read analytics for.

Response

Metrics for the post.

post_idstring required

The post these numbers belong to.

collection_status'active' | 'completed' | 'auth_required' | 'permission_disabled' | 'unsupported' | 'unavailable' | 'possibly_deleted' | 'deleted' | 'retrying' required

Why the numbers look the way they do. active is still being collected and completed has finished; anything else explains why collection stopped, so zeroes are not mistaken for genuine silence.

last_error_atstring date-time

When collection last failed, if it has.

Changes

No recorded changes to this operation across all 2 revisions of this API.