Breakout posts

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

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

fetch('https://api.growi.io/api/public/v1/content/breakout_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/breakout_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/breakout_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/breakout_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": {
    "posts": [
      {
        "social_post_id": "<string>",
        "platform": "<string>",
        "user_id": 123,
        "creator_name": "<string>",
        "avatar_url": "<string>",
        "username": "<string>",
        "thumbnail_url": "<string>",
        "post_url": "<string>",
        "gain_24h": 123,
        "pace": 123,
        "pace_ratio": 123,
        "lifetime_total": 123,
        "sparkline": [
          123
        ]
      }
    ]
  },
  "meta": {
    "scope": "family",
    "organization_id": 123,
    "campaign_ids": [
      123
    ],
    "platform": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Breakout posts

Posts gaining far faster than their own normal pace right now. Always “now”: start_date and end_date are ignored (meta.window gives the days used). gain_24h is the views a post gained yesterday (the latest complete UTC day) plus today so far; its normal pace is its average daily views gain over the 7 days before yesterday, and pace_ratio = gain_24h / pace. Posts whose pace is under 100 views a day, or that were first tracked inside the window, are left out. sparkline is the last 7 days’ gains, oldest first, ending today. Live: new post readings show up on the next call.

GET

content

breakout_posts

Breakout posts

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

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

fetch('https://api.growi.io/api/public/v1/content/breakout_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/breakout_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/breakout_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/breakout_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": {
    "posts": [
      {
        "social_post_id": "<string>",
        "platform": "<string>",
        "user_id": 123,
        "creator_name": "<string>",
        "avatar_url": "<string>",
        "username": "<string>",
        "thumbnail_url": "<string>",
        "post_url": "<string>",
        "gain_24h": 123,
        "pace": 123,
        "pace_ratio": 123,
        "lifetime_total": 123,
        "sparkline": [
          123
        ]
      }
    ]
  },
  "meta": {
    "scope": "family",
    "organization_id": 123,
    "campaign_ids": [
      123
    ],
    "platform": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

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

min_ratio

number

Smallest pace_ratio to include. Default 5.

limit

integer

Posts, 1-20. Default 5.

Response

success

boolean

data

object

Show child attributes

Overview

Organization

Creators and campaigns

Content analytics

Sales and stores

Payouts

TikTok Shop

Meta ads

Deprecated

Breakout posts

Authorizations

Query Parameters

Response