publications

List publications with their metrics

Publications sent in the range, each with its last known normalized metrics, ordered by the requested metric. Covers the organization and its children.

Two things to keep in mind when reading the response:

  • summary always covers the whole organization; social_network and accounts filter only the listing. Pass summary=false when paging so the aggregates are not recomputed on every page — they only depend on the date range.
  • Publications that have not been measured yet are included, with metrics absent. That is the difference with /publications/top, which can only rank what has already been measured. An absent metric is not a zero.

Only sended publications are listed: a draft or a scheduled publication has nothing to measure.

get/organizations/{id_organization}/publications/stats

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/publications/stats
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Query parameters

from_datestring date-time

Start of the range, filtered by publication date. Defaults to 30 days before to_date. The range cannot be longer than 366 days.

to_datestring date-time

End of the range, filtered by publication date. Defaults to now.

metric'impressions' | 'reach' | 'engagement' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'video_views' | 'profile_views'

Normalized metric the listing is ordered by, descending. Publications that lack it are not dropped: they sort last.

social_networkstring[]

Filter the listing by network. Repeat the parameter for several. Does not affect summary.

accountsstring[]

Filter the listing by account identifier. Repeat the parameter for several. Does not affect summary.

summaryboolean

Set to false to skip the aggregates and return only the listing page. They depend on the range alone, so paging with summary=false avoids recomputing them.

limitinteger

Publications per page

offsetinteger

Publications to skip

Response

Successful operation

metricstring

Metric the listing is ordered by

totalinteger

Publications matching the filters, for paging

Example response

{
  "publications": [
    {
      "files": [
        {
          "file_properties": {
            "aspect_ratio": {
              "value": 1.7777777777777777,
              "text": "16:9"
            }
          },
          "public_path": "https://a1b2c3d4e5f6.eu.r2.cloudflarestorage.com/planvortex-prod/orgs/60b.../60c.../foto.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=86400&X-Amz-Signature=..."
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.