Top posts

curl --request GET \
  --url https://api.growi.io/api/public/v1/content/top_posts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/content/top_posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/content/top_posts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/content/top_posts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/content/top_posts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "<string>",
        "platform": "<string>",
        "content_type": "<string>",
        "external_id": "<string>",
        "title": "<string>",
        "posted_at": "2023-11-07T05:31:56Z",
        "share_url": "<string>",
        "account": {
          "id": "<string>",
          "platform": "<string>",
          "platform_uid": "<string>",
          "username": "<string>",
          "name": "<string>",
          "avatar_url": "<string>",
          "profile_share_url": "<string>"
        },
        "creator": {
          "id": 123,
          "name": "<string>",
          "avatar_url": "<string>"
        },
        "metrics": {
          "views": 123,
          "likes": 123,
          "comments": 123,
          "shares": 123,
          "saves": 123,
          "engagement_rate": 123
        }
      }
    ],
    "page": 123,
    "limit": 123,
    "sort": "<string>",
    "min_views": 123
  },
  "meta": {
    "scope": "family",
    "organization_id": 123,
    "campaign_ids": [
      123
    ],
    "platform": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

content

top_posts

Top posts

curl --request GET \
  --url https://api.growi.io/api/public/v1/content/top_posts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/content/top_posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/content/top_posts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/content/top_posts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/content/top_posts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "<string>",
        "platform": "<string>",
        "content_type": "<string>",
        "external_id": "<string>",
        "title": "<string>",
        "posted_at": "2023-11-07T05:31:56Z",
        "share_url": "<string>",
        "account": {
          "id": "<string>",
          "platform": "<string>",
          "platform_uid": "<string>",
          "username": "<string>",
          "name": "<string>",
          "avatar_url": "<string>",
          "profile_share_url": "<string>"
        },
        "creator": {
          "id": 123,
          "name": "<string>",
          "avatar_url": "<string>"
        },
        "metrics": {
          "views": 123,
          "likes": 123,
          "comments": 123,
          "shares": 123,
          "saves": 123,
          "engagement_rate": 123
        }
      }
    ],
    "page": 123,
    "limit": 123,
    "sort": "<string>",
    "min_views": 123
  },
  "meta": {
    "scope": "family",
    "organization_id": 123,
    "campaign_ids": [
      123
    ],
    "platform": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Replaces /stats/top_posts_by_views, which is deprecated.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organization_id

integer

Read one of your child brands instead of the organization that owns the key. Any id that is not one of your brands answers 404.

start_date

string<date>

First day, YYYY-MM-DD. Default: 29 days ago.

end_date

string<date>

Last day, YYYY-MM-DD. Default: today (UTC).

campaign_ids

string

Comma separated campaign ids (from /content/filters). One id reads that campaign; several read their union, a post in two of them counting once. Every id must belong to your organization.

platform

enum<string>

Only this platform.

Available options:

instagram,

tik_tok,

youtube,

facebook,

twitter

sort

enum<string>

Rank by this metric. engagement is (likes + comments + shares + saves) / views and ignores rows under 100 views. Default views.

Available options:

views,

likes,

comments,

shares,

saves,

engagement

limit

integer

Rows per page, 1-50. Default 10.

page

integer

Page number, from 1. Default 1.

Response

success

boolean

data

object

Show child attributes

Overview

Organization

Creators and campaigns

Content analytics

Sales and stores

Payouts

TikTok Shop

Meta ads

Deprecated

Top posts

Authorizations

Query Parameters

Response