Skip to main content
GET
Get an analytics dashboard

Request contract

  • Method and path: GET /apis/v1/social/analytics/dashboard
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/social/analytics/dashboard
  • profileId: query; optional
  • platform: query; optional
  • fromDate: query; required
  • toDate: query; required
  • compare: query; optional
  • topPosts: query; optional
  • recentPosts: query; optional
  • Runtime facts: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization
string
header
required

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

Query Parameters

profileId
string

One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.

Pattern: ^prf_[0-9A-Za-z]{22}$
platform
string
default:all

Platform to cover (e.g. "instagram"), or "all".

fromDate
string<date>
required

First day of the window (YYYY-MM-DD, inclusive).

toDate
string<date>
required

Last day of the window (YYYY-MM-DD, inclusive). May equal fromDate. The window covers at most 366 days.

compare
enum<string>

Set to "previous_period" to also return previousTotals and previousFollowers for the window of the same length that ends the day before fromDate.

Available options:
previous_period
topPosts
integer
default:5

How many top posts to return, ranked by engagement (likes, comments, shares and saves, the same sum as daily engagement).

Required range: 0 <= x <= 25
recentPosts
integer
default:10

How many of the most recently published posts to return.

Required range: 0 <= x <= 25

Response

Dashboard for the window

daily
object[]
required

One entry per day of the window, days without data included as zeros.

dataAsOf
string<date-time> | null
required

When the most recently synced account in scope was last synced. Null if none has synced yet.

dateRange
object
required
followers
object
required
recentPosts
object[]
required
topPosts
object[]
required
totals
object
required
previousFollowers
object
previousTotals
object