Platform Analytics

Get analytics data for a specific integration/channel. Returns metrics like followers, impressions, engagement, etc. depending on the platform.

OpenAPI

openapi: 3.1.0
info:
  title: Sipstory Public API
  description: >-
    API for managing social media posts, integrations, and media uploads in
    Sipstory.


    ## Authentication


    All endpoints require an API key passed in the `Authorization` header:


    ```

    Authorization: your-api-key

    ```


    Get your API key from Sipstory Settings.


    ## Rate Limits


    There is a limit of **30 requests per hour**.


    ## Terminology


    The UI uses `channel`, but the API uses `integration`. They refer to the
    same thing.


    ## Supported Platforms (27)


    **Social Platforms:** X (Twitter), LinkedIn, LinkedIn Page, Facebook,
    Instagram, Instagram Standalone, Threads, Bluesky, Mastodon, Warpcast
    (Farcaster), Nostr, VK


    **Video Platforms:** YouTube, TikTok


    **Community Platforms:** Reddit, Lemmy, Discord, Slack, Telegram


    **Design Platforms:** Pinterest, Dribbble


    **Blogging Platforms:** Medium, Dev.to, Hashnode, WordPress


    **Business:** Google My Business (GMB), Listmonk (newsletters)
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.sipstory.tech/public/v1
    description: Sipstory Cloud
  - url: https://{your-domain}/api/public/v1
    description: Self-hosted
    variables:
      your-domain:
        default: localhost:5000
        description: Your Sipstory instance domain
security:
  - ApiKeyAuth: []
tags:
  - name: Integrations
    description: Manage connected social media channels
  - name: Posts
    description: Create, list, and delete posts
  - name: Uploads
    description: Upload media files
  - name: Notifications
    description: View organization notifications
  - name: Analytics
    description: View analytics for integrations and posts
  - name: Video Generation
    description: Generate videos with AI
paths:
  /analytics/{integration}:
    get:
      tags:
        - Analytics
      summary: Get platform analytics
      description: >-
        Get analytics data for a specific integration/channel. Returns metrics
        like followers, impressions, engagement, etc. depending on the platform.
      operationId: getAnalytics
      parameters:
        - name: integration
          in: path
          required: true
          description: Integration ID
          schema:
            type: string
        - name: date
          in: query
          required: true
          description: Number of days to look back for analytics data (e.g. 7, 30, 90)
          schema:
            type: string
          example: '7'
      responses:
        '200':
          description: Analytics data for the integration
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AnalyticsData'
              example:
                - label: Followers
                  data:
                    - total: '1250'
                      date: '2025-01-01'
                    - total: '1280'
                      date: '2025-01-02'
                  percentageChange: 2.4
                - label: Impressions
                  data:
                    - total: '5000'
                      date: '2025-01-01'
                    - total: '5200'
                      date: '2025-01-02'
                  percentageChange: 4
components:
  schemas:
    AnalyticsData:
      type: object
      properties:
        label:
          type: string
          description: Metric label (e.g. Followers, Impressions, Likes)
        data:
          type: array
          items:
            type: object
            properties:
              total:
                type: string
                description: Metric value for this date
              date:
                type: string
                description: Date string (YYYY-MM-DD)
        percentageChange:
          type: number
          description: Percentage change over the selected period
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Your Sipstory API key