Metricool Twitter Analytics Api Service API

openapi: 3.2.0
info:
  title: Metricool Twitter Analytics Api Service API
  description: 'Metricool API


    The base URL for all endpoints is: https://app.metricool.com/api


    All endpoints require authentication.'
  version: 2.0.0
servers:
- url: https://app.metricool.com/api
tags:
- name: Twitter Analytics Api Service
paths:
  /v2/analytics/posts/twitter:
    get:
      tags:
      - Twitter Analytics Api Service
      summary: Download a CSV with the list of twitter posts (tweets) created during a period…
      operationId: downloadTwitterPostsCSV
      parameters:
      - name: from
        in: query
        description: From Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
        required: true
        schema:
          type: string
      - name: to
        in: query
        description: To Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
        required: true
        schema:
          type: string
      - name: timezone
        in: query
        description: (Optional) The timezone used for the date range to search. ('Europe/Madrid')
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
  /v2/analytics/posts/twitter/follows-unfollows/timeline:
    get:
      tags:
      - Twitter Analytics Api Service
      summary: 'Returns the follows/unfollows-per-post timeline for X (Twitter): one point per…'
      operationId: getFollowsUnfollowsPerPostTimeline
      parameters:
      - name: from
        in: query
        description: From Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
        required: true
        schema:
          type: string
      - name: to
        in: query
        description: To Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
        required: true
        schema:
          type: string
      - name: timezone
        in: query
        description: (Optional) The timezone used for the date range to search. ('Europe/Madrid')
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseTwitterFollowsPerPostPoint'
  /v2/analytics/twitter/events/{type}:
    get:
      tags:
      - Twitter Analytics Api Service
      summary: Returns the list of twitter accounts that followed or unfollowed the main…
      operationId: getTwitterEvents_1
      parameters:
      - name: type
        in: path
        required: true
        schema:
          minLength: 1
          type: string
      - name: from
        in: query
        description: From Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
        required: true
        schema:
          type: string
      - name: to
        in: query
        description: To Date and time ISO 8601 format. e.g. 2021-01-01T10:00:00
        required: true
        schema:
          type: string
      - name: timezone
        in: query
        description: (Optional) The timezone used for the date range to search. ('Europe/Madrid')
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TwitterEvent'
components:
  schemas:
    TwitterEvent:
      type: object
      properties:
        twitterId:
          type: integer
          format: int64
        date:
          type: integer
          format: int32
        screenName:
          type: string
        fullName:
          type: string
        picture:
          type: string
        url:
          type: string
        description:
          type: string
        followers:
          type: integer
          format: int32
        friends:
          type: integer
          format: int32
        isFollowedByMe:
          type: boolean
        isFollowingMe:
          type: boolean
        isMuted:
          type: boolean
        isBlocked:
          type: boolean
        isProtected:
          type: boolean
        isVerified:
          type: boolean
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    TwitterFollowsPerPostPoint:
      type: object
      properties:
        tweetId:
          type: string
          description: Tweet ID of the published post
          example: '1750000000000000000'
        date:
          $ref: '#/components/schemas/DateTimeInfo'
        follows:
          type: integer
          description: Follows generated by this post
          format: int32
          example: 12
        unfollows:
          type: integer
          description: Unfollows generated by this post
          format: int32
          example: 3
      description: 'A single point of the X (Twitter) follows/unfollows-per-post timeline: one published post with the follows and unfollows it generated.'
    JsonOkListResponseTwitterFollowsPerPostPoint:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/TwitterFollowsPerPostPoint'
    DateTimeInfo:
      required:
      - dateTime
      type: object
      properties:
        dateTime:
          type: string
          description: 'Local Date-time represented with a certain timezone '
        timezone:
          type: string
          description: Timezone applied to the datetime