GET
/
v1
/
teams
/
{teamId}
/
posts
/
performance
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.socialListPostPerformance({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {},
})
{
  "data": [
    {
      "scheduledPostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "current": {
        "likeCount": 123,
        "commentCount": 123,
        "shareCount": 123,
        "saveCount": 123,
        "impressionCount": 123,
        "reachCount": 123
      },
      "engagementRate": 123,
      "performanceScore": 50,
      "lastCollectedAt": "<string>"
    }
  ],
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

teamId
string
required

Query Parameters

cursor
string
limit
string
sortBy
enum<string>
Available options:
engagement_rate,
performance_score,
virality_score,
sortOrder
enum<string>
Available options:
asc,
desc,
from
string
to
string
platform
enum<string>
Available options:
x,
tiktok,
instagram,
facebook,
youtube,
linkedin,
threads,
filter[from]
string
filter[to]
string
filter[platform]
enum<string>
Available options:
x,
tiktok,
instagram,
facebook,
youtube,
linkedin,
threads,

Response

Success

data
object[]
required
total
number
required
nextCursor
string | null
required
prevCursor
string | null
required