dashboard

Best publications of the range

The publications with the highest value of one metric.

A publication whose network does not report that metric does not compete, it is left out of the ranking rather than ranked as a zero. That is why asking for saves can return fewer rows than asking for engagement.

get/organizations/{id_organization}/publications/top

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/publications/top
  • 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, ISO 8601. Defaults to 30 days before to_date. A range longer than 366 days answers error 1003.

to_datestring date-time

End of the range, ISO 8601. Defaults to now.

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

A metric in PlanVortex's common vocabulary. Each network reports what it reports and PlanVortex translates it; a metric a network does not publish is absent, never zero.

Metric to rank by.

limitinteger

How many publications to return.

Response

Top publications

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

A metric in PlanVortex's common vocabulary. Each network reports what it reports and PlanVortex translates it; a metric a network does not publish is absent, never zero.

Example response

{
  "publications": [
    {
      "publication": {
        "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.