> ## Documentation Index
> Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative.
> - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key.
> - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste.
> - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`.
> - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt

# Get an analytics dashboard

> Analytics. Read only; needs social:read. Ids are yours: accounts acc_..., profiles prf_..., posts pst_...; every other object id is checked against your accounts before the call. Without profileId or accountId it reads your default profile.

Everything an analytics dashboard needs in one call: window totals, follower growth, a per-day series, top posts, recent posts and, optionally, the same figures for the previous period.

All dates are UTC days.

### Daily and total metrics

Daily and total metrics use received attribution: each day holds the engagement that arrived that day, on any post. So `totals` is always the sum of `daily`.

### Post lists

`topPosts` and `recentPosts` list posts published in the window with their lifetime metrics. A post cross-posted to several platforms appears once per platform.

<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->

## 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](https://aisa.one/docs/reference-contracts/aisa-social.json)

Effective request and pricing declaration (including authentication and referenced schemas):

```json theme={null}
{
  "operationId": "get_aisa_social_apis_v1_social_analytics_dashboard",
  "method": "GET",
  "path": "/apis/v1/social/analytics/dashboard",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "description": "One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.",
      "in": "query",
      "name": "profileId",
      "required": false,
      "schema": {
        "pattern": "^prf_[0-9A-Za-z]{22}$",
        "type": "string"
      }
    },
    {
      "description": "Platform to cover (e.g. \"instagram\"), or \"all\".",
      "in": "query",
      "name": "platform",
      "required": false,
      "schema": {
        "default": "all",
        "type": "string"
      }
    },
    {
      "description": "First day of the window (YYYY-MM-DD, inclusive).",
      "in": "query",
      "name": "fromDate",
      "required": true,
      "schema": {
        "format": "date",
        "type": "string"
      }
    },
    {
      "description": "Last day of the window (YYYY-MM-DD, inclusive). May equal fromDate. The window covers at most 366 days.",
      "in": "query",
      "name": "toDate",
      "required": true,
      "schema": {
        "format": "date",
        "type": "string"
      }
    },
    {
      "description": "Set to \"previous_period\" to also return previousTotals and previousFollowers for the window of the same length that ends the day before fromDate.",
      "in": "query",
      "name": "compare",
      "required": false,
      "schema": {
        "enum": [
          "previous_period"
        ],
        "type": "string"
      }
    },
    {
      "description": "How many top posts to return, ranked by engagement (likes, comments, shares and saves, the same sum as daily engagement).",
      "in": "query",
      "name": "topPosts",
      "required": false,
      "schema": {
        "default": 5,
        "maximum": 25,
        "minimum": 0,
        "type": "integer"
      }
    },
    {
      "description": "How many of the most recently published posts to return.",
      "in": "query",
      "name": "recentPosts",
      "required": false,
      "schema": {
        "default": 10,
        "maximum": 25,
        "minimum": 0,
        "type": "integer"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "description": "Included with your connected social accounts: AIsa does not charge per call.",
    "kind": "no_customer_charge"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```

## 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.


## OpenAPI

````yaml reference-contracts/aisa-social.json GET /apis/v1/social/analytics/dashboard
openapi: 3.1.0
info:
  description: ''
  title: AIsa Social
  version: '1'
  x-aisa-capabilities:
    idempotency: Idempotency-Key
    max_price: X-AISA-Max-Price-USD
    quote:
      header: X-AISA-Cost-Mode
      value: quote
  x-aisa-configured-paths: []
  x-aisa-document:
    facts_hash: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
    generator_version: '3'
    protocol_version: '1'
    schema_version: '1'
    composer_version: '27'
    response_pending: []
    document_hash: sha256:7f9742cb1ea233c648dcb290fdfbf24e53a27dcf900ec1386f83a8ef2e6b1bf9
  x-aisa-plans:
    builder: 1
    display_plan: payg
    payg: 1
    similarweb_payg: 1
    team: 1
    version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
  x-aisa-provider: aisa-social
  x-aisa-catalogs:
    aisa-social:
      title: AIsa Social
      description: ''
      x-aisa-document:
        facts_hash: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
        generator_version: '3'
        protocol_version: '1'
        schema_version: '1'
      x-aisa-plans:
        builder: 1
        display_plan: payg
        payg: 1
        similarweb_payg: 1
        team: 1
        version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
      x-aisa-capabilities:
        idempotency: Idempotency-Key
        max_price: X-AISA-Max-Price-USD
        quote:
          header: X-AISA-Cost-Mode
          value: quote
servers:
  - url: https://api.aisa.one
security:
  - bearerAuth: []
paths:
  /apis/v1/social/analytics/dashboard:
    get:
      summary: Get an analytics dashboard
      description: >-
        Analytics. Read only; needs social:read. Ids are yours: accounts
        acc_..., profiles prf_..., posts pst_...; every other object id is
        checked against your accounts before the call. Without profileId or
        accountId it reads your default profile.


        Everything an analytics dashboard needs in one call: window totals,
        follower growth, a per-day series, top posts, recent posts and,
        optionally, the same figures for the previous period.


        All dates are UTC days.


        ### Daily and total metrics


        Daily and total metrics use received attribution: each day holds the
        engagement that arrived that day, on any post. So `totals` is always the
        sum of `daily`.


        ### Post lists


        `topPosts` and `recentPosts` list posts published in the window with
        their lifetime metrics. A post cross-posted to several platforms appears
        once per platform.


        <!-- aisa-pricing:start -->

        A request reference price is not currently available; use a request
        quote where supported. Account-specific pricing and final settlement may
        differ.

        <!-- aisa-pricing:end -->
      operationId: get_aisa_social_apis_v1_social_analytics_dashboard
      parameters:
        - description: >-
            One of your profiles (prf_...). Defaults to your default profile
            when neither profileId nor accountId is sent.
          in: query
          name: profileId
          required: false
          schema:
            pattern: ^prf_[0-9A-Za-z]{22}$
            type: string
        - description: Platform to cover (e.g. "instagram"), or "all".
          in: query
          name: platform
          required: false
          schema:
            default: all
            type: string
        - description: First day of the window (YYYY-MM-DD, inclusive).
          in: query
          name: fromDate
          required: true
          schema:
            format: date
            type: string
        - description: >-
            Last day of the window (YYYY-MM-DD, inclusive). May equal fromDate.
            The window covers at most 366 days.
          in: query
          name: toDate
          required: true
          schema:
            format: date
            type: string
        - description: >-
            Set to "previous_period" to also return previousTotals and
            previousFollowers for the window of the same length that ends the
            day before fromDate.
          in: query
          name: compare
          required: false
          schema:
            enum:
              - previous_period
            type: string
        - description: >-
            How many top posts to return, ranked by engagement (likes, comments,
            shares and saves, the same sum as daily engagement).
          in: query
          name: topPosts
          required: false
          schema:
            default: 5
            maximum: 25
            minimum: 0
            type: integer
        - description: How many of the most recently published posts to return.
          in: query
          name: recentPosts
          required: false
          schema:
            default: 10
            maximum: 25
            minimum: 0
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  daily:
                    description: >-
                      One entry per day of the window, days without data
                      included as zeros.
                    items:
                      properties:
                        date:
                          format: date
                          type: string
                        engagement:
                          description: Likes, comments, shares and saves received that day.
                          type: integer
                        followersGained:
                          description: >-
                            Net follower change against the previous snapshot.
                            Can be negative.
                          type: integer
                        impressions:
                          type: integer
                        reach:
                          type: integer
                        views:
                          type: integer
                      type: object
                    type: array
                  dataAsOf:
                    description: >-
                      When the most recently synced account in scope was last
                      synced. Null if none has synced yet.
                    format: date-time
                    type:
                      - string
                      - 'null'
                  dateRange:
                    properties:
                      fromDate:
                        format: date
                        type: string
                      toDate:
                        format: date
                        type: string
                    type: object
                  followers:
                    properties:
                      byAccount:
                        items:
                          properties:
                            accountId:
                              description: One of your social accounts (acc_...).
                              pattern: ^acc_[0-9A-Za-z]{22}$
                              type: string
                            current:
                              type: integer
                            gained:
                              type: integer
                            platform:
                              type: string
                          type: object
                        type: array
                      current:
                        description: >-
                          Live follower count when the window includes today,
                          otherwise the count the window ended on.
                        type: integer
                      gained:
                        description: >-
                          Last minus first follower snapshot inside the window.
                          Can be negative.
                        type: integer
                    type: object
                  previousFollowers:
                    properties:
                      byAccount:
                        items:
                          properties:
                            accountId:
                              description: One of your social accounts (acc_...).
                              pattern: ^acc_[0-9A-Za-z]{22}$
                              type: string
                            current:
                              type: integer
                            gained:
                              type: integer
                            platform:
                              type: string
                          type: object
                        type: array
                      current:
                        description: >-
                          Live follower count when the window includes today,
                          otherwise the count the window ended on.
                        type: integer
                      gained:
                        description: >-
                          Last minus first follower snapshot inside the window.
                          Can be negative.
                        type: integer
                    type: object
                  previousTotals:
                    properties:
                      clicks:
                        type: integer
                      comments:
                        type: integer
                      engagementRate:
                        description: >-
                          Percentage. Likes, comments, shares and saves over
                          impressions, pooled per platform (reach, then views,
                          when a platform has no impressions).
                        type: number
                      impressions:
                        type: integer
                      likes:
                        type: integer
                      reach:
                        type: integer
                      saves:
                        type: integer
                      shares:
                        type: integer
                      views:
                        type: integer
                    type: object
                  recentPosts:
                    items:
                      properties:
                        metrics:
                          description: Lifetime metrics of the post on this platform.
                          properties:
                            clicks:
                              type: integer
                            comments:
                              type: integer
                            engagementRate:
                              type: number
                            impressions:
                              type: integer
                            likes:
                              type: integer
                            reach:
                              type: integer
                            saves:
                              type: integer
                            shares:
                              type: integer
                            views:
                              type: integer
                          type: object
                        platform:
                          type: string
                        postId:
                          type: string
                        publishedAt:
                          format: date-time
                          type: string
                      type: object
                    type: array
                  topPosts:
                    items:
                      properties:
                        metrics:
                          description: Lifetime metrics of the post on this platform.
                          properties:
                            clicks:
                              type: integer
                            comments:
                              type: integer
                            engagementRate:
                              type: number
                            impressions:
                              type: integer
                            likes:
                              type: integer
                            reach:
                              type: integer
                            saves:
                              type: integer
                            shares:
                              type: integer
                            views:
                              type: integer
                          type: object
                        platform:
                          type: string
                        postId:
                          type: string
                        publishedAt:
                          format: date-time
                          type: string
                      type: object
                    type: array
                  totals:
                    properties:
                      clicks:
                        type: integer
                      comments:
                        type: integer
                      engagementRate:
                        description: >-
                          Percentage. Likes, comments, shares and saves over
                          impressions, pooled per platform (reach, then views,
                          when a platform has no impressions).
                        type: number
                      impressions:
                        type: integer
                      likes:
                        type: integer
                      reach:
                        type: integer
                      saves:
                        type: integer
                      shares:
                        type: integer
                      views:
                        type: integer
                    type: object
                required:
                  - daily
                  - dataAsOf
                  - dateRange
                  - followers
                  - recentPosts
                  - topPosts
                  - totals
                type: object
          description: Dashboard for the window
        default:
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type:
                          - string
                          - 'null'
                      details:
                        additionalProperties: {}
                        type:
                          - object
                          - 'null'
                      message:
                        type:
                          - string
                          - 'null'
                      param:
                        type:
                          - string
                          - 'null'
                      retryHint:
                        enum:
                          - never
                          - after_delay
                          - after_reconnect
                          - reconcile_first
                          - null
                        type:
                          - string
                          - 'null'
                      retryable:
                        type:
                          - boolean
                          - 'null'
                      type:
                        type:
                          - string
                          - 'null'
                    type:
                      - object
                      - 'null'
                type: object
          description: Error. The code field is stable; see the error catalog.
components:
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.