Analytics for a period

GET

/analytics/overview

const url = 'https://api.dropslate.top/v1/analytics/overview?compare=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.dropslate.top/v1/analytics/overview?compare=0' \
  --header 'Authorization: Bearer <token>'

Posts published through Dropslate that went live in the period, with the latest numbers each network reported, and the accounts’ followers and views by day. The worker reads accounts daily and posts every few hours (young posts more often), so numbers can lag a few hours behind the network. coverage says per account whether its login lets Dropslate read analytics (needs_reconnect: connect it again to grant it).

Authorizations

bearerAuth

Parameters

Query Parameters

from

string format: date

UTC day, included. Default: 29 days before to. Moved up to the plan’s history (Free 30 days, Creator 90, Studio and Agency 365).

string format: date

UTC day, included. Default: today. At most 366 days after from.

accountIds

string

Comma-separated; an id of another workspace answers 404.

platforms

string

Comma-separated, e.g. youtube,instagram.

compare

string

Allowed values: 0 1

Also total the period just before.

Responses

200

Totals, by day and by network.

application/json

object

period

object

from

string format: date

previous

object

from

string format: date

history

object

days

integer

nullable

clamped

boolean

totals

object

views

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

engagements

Likes, comments, shares and saves together.

integer

nullable

engagementRate

Engagements per view; null when either is unknown or nothing was viewed.

number

nullable

followersNet

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

postsLive

integer

previousTotals

object

views

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

engagements

Likes, comments, shares and saves together.

integer

nullable

engagementRate

Engagements per view; null when either is unknown or nothing was viewed.

number

nullable

followersNet

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

postsLive

integer

daily

Array<object>

object

date

string format: date

platform

string

Allowed values: youtube instagram facebook threads tiktok

views

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

engagements

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

followers

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

followersNet

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

byPlatform

Array<object>

object

platform

string

Allowed values: youtube instagram facebook threads tiktok

views

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

engagements

Null when the network gives no such metric; never 0 for unknown.

integer

nullable

engagementRate

Engagements per view; null when either is unknown or nothing was viewed.

number

nullable

postsLive

integer

coverage

Array<object>

object

accountId

string

platform

string

Allowed values: youtube instagram facebook threads tiktok

insights

string

Allowed values: ok needs_reconnect unsupported pending

updatedAt

string format: date-time

nullable

countries

Followers by country (ISO 3166-1 alpha-2), the latest breakdown of each account up to the end of the period, summed; Instagram and Threads give one (1.4.0).

Array<object>

object

country

string

followers

integer

countriesFrom

The networks the countries come from.

Array<string>

Allowed values: youtube instagram facebook threads tiktok

updatedAt

string format: date-time

nullable

Example

{
  "daily": [
    {
      "platform": "youtube"
    }
  ],
  "byPlatform": [
    {
      "platform": "youtube"
    }
  ],
  "coverage": [
    {
      "platform": "youtube",
      "insights": "ok"
    }
  ],
  "countries": [
    {
      "country": "UA"
    }
  ],
  "countriesFrom": [
    "youtube"
  ]
}

400

A date or filter that is not one (invalid_request).

application/json

object

code

required

string

message

required

string

hint

string

Example

{
  "code": "not_found",
  "message": "The post does not exist.",
  "hint": "Check the id and try again."
}

404

Does not exist, or belongs to a different workspace - the two look identical from here.

application/json

object

code

required

string

message

required

string

hint

string

Example

{
  "code": "not_found",
  "message": "The post does not exist.",
  "hint": "Check the id and try again."
}