Spike days

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

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

fetch('https://api.growi.io/api/public/v1/content/spikes', 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/spikes",
  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/spikes"

	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/spikes")

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": {
    "metric": "<string>",
    "threshold": 123,
    "baseline_days": 123,
    "spikes": [
      {
        "date": "2023-12-25",
        "value": 123,
        "baseline": 123,
        "ratio": 123,
        "top": {
          "social_post_id": "<string>",
          "platform": "<string>",
          "user_id": 123,
          "creator_name": "<string>",
          "gain": 123,
          "share": 123
        }
      }
    ]
  },
  "meta": {
    "scope": "family",
    "organization_id": 123,
    "campaign_ids": [
      123
    ],
    "platform": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Spike days

The days in the range where a metric jumped well above normal, each with the post that drove it most. A day is a spike when it gained at least threshold times the median of the baseline_days days before it; the baseline also uses days before start_date, so the first days of the range are covered. Today (a partial day) is never a spike, and neither is a day whose baseline is under 1000 (small numbers swing on a single post). top.share is the top post’s gain divided by the day’s value (0-1). Live: new post readings show up on the next call.

GET

content

spikes

Spike days

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

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

fetch('https://api.growi.io/api/public/v1/content/spikes', 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/spikes",
  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/spikes"

	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/spikes")

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": {
    "metric": "<string>",
    "threshold": 123,
    "baseline_days": 123,
    "spikes": [
      {
        "date": "2023-12-25",
        "value": 123,
        "baseline": 123,
        "ratio": 123,
        "top": {
          "social_post_id": "<string>",
          "platform": "<string>",
          "user_id": 123,
          "creator_name": "<string>",
          "gain": 123,
          "share": 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

metric

enum<string>

The metric. Default views.

Available options:

views,

likes,

comments,

shares,

saves

baseline_days

integer

Days in the baseline median, 3-60. Default 14.

threshold

number

How many times the baseline a day must reach. Default 3.

Response

success

boolean

data

object

Show child attributes

Overview

Organization

Creators and campaigns

Content analytics

Sales and stores

Payouts

TikTok Shop

Meta ads

Deprecated

Spike days

Authorizations

Query Parameters

Response