openapi: 3.2.0
info:
  title: Opoint Trends API
  version: 1.0.0
  description: 'Operations tagged trends across 2 of this provider''s published API definitions: opoint-openapi-original.yml, opoint-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.opoint.com
tags:
- name: Trends
paths:
  /trends/preset/:
    get:
      operationId: trends_preset_list
      tags:
      - Trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TrendPreset'
          description: ''
      summary: Trends preset list
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
  /trends/preset/{id}/:
    get:
      operationId: trends_preset_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this trend opts preset.
        required: true
      tags:
      - Trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendPreset'
          description: ''
      summary: Trends preset retrieve
      x-summary-source: derived
    servers:
    - url: https://api.opoint.com
  /trends/profile/{profile_id}/:
    query:
      operationId: trends_profile_query
      summary: Get trend data on profile
      parameters:
      - in: path
        name: profile_id
        schema:
          type: integer
        required: true
      - in: query
        name: search_term
        schema:
          type: string
        description: Additional search expression
      tags:
      - trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    get:
      operationId: trends_profile_retrieve
      summary: Get trend data on profile
      parameters:
      - in: path
        name: profile_id
        schema:
          type: integer
        required: true
      - in: query
        name: search_term
        schema:
          type: string
        description: Additional search expression
      tags:
      - Trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    post:
      operationId: trend_profile_view_query
      summary: Get trend data on profile
      parameters:
      - in: path
        name: profile_id
        schema:
          type: integer
        required: true
      tags:
      - Trends
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
        required: true
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    servers:
    - url: https://api.opoint.com
  /trends/search/:
    query:
      operationId: trends_search_query
      summary: Get trend data
      parameters:
      - in: query
        name: search_term
        schema:
          type: string
        description: Additional search expression
      tags:
      - trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    get:
      operationId: trends_search_retrieve
      summary: Get trend data
      parameters:
      - in: query
        name: search_term
        schema:
          type: string
        description: Additional search expression
      tags:
      - Trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    post:
      operationId: trends_search_create
      summary: Get trend data
      tags:
      - Trends
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
        required: true
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    servers:
    - url: https://api.opoint.com
  /trends/v2/:
    query:
      operationId: trends_v2_query
      summary: Get trend data
      parameters:
      - in: query
        name: search_term
        schema:
          type: string
        description: Additional search expression
      tags:
      - trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    get:
      operationId: trends_v2_retrieve
      summary: Get trend data
      parameters:
      - in: query
        name: search_term
        schema:
          type: string
        description: Additional search expression
      tags:
      - Trends
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    post:
      operationId: trends_v2_create
      summary: Get trend data
      tags:
      - Trends
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TrendExpressions'
        required: true
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendResponseSerializerv2'
          description: success
    servers:
    - url: https://api.opoint.com
components:
  schemas:
    TrendEpochSerializerv2:
      type: object
      properties:
        timestamp:
          type: integer
        articles:
          type: array
          items:
            $ref: '#/components/schemas/ArticleIdsSerializerv2'
        frequency:
          type: integer
      required:
      - articles
      - frequency
      - timestamp
    ArticleIdsSerializerv2:
      type: object
      properties:
        id_site:
          type: integer
        id_article:
          type: integer
      required:
      - id_article
      - id_site
    TrendExpressions:
      type: object
      properties:
        expressions:
          type: array
          items:
            $ref: '#/components/schemas/ProfileItem'
      required:
      - expressions
    SearchLine:
      type: object
      properties:
        searchterm:
          type: string
        filters:
          type: array
          items:
            $ref: '#/components/schemas/SearchLineFilter'
    ProfileItem:
      type: object
      properties:
        id:
          type: integer
        searchline:
          $ref: '#/components/schemas/SearchLine'
        linemode:
          $ref: '#/components/schemas/LinemodeEnum'
        searchmode:
          type: string
          writeOnly: true
      required:
      - linemode
      - searchline
      - searchmode
    TrendPreset:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 255
        params: {}
      required:
      - id
      - name
      - params
    SearchLineFilter:
      type: object
      properties:
        type:
          type: string
        id:
          type: string
      required:
      - type
    LinemodeEnum:
      enum:
      - R
      - O
      - E
      type: string
      description: '* `R` - Required

        * `O` - Optional

        * `E` - Exclude'
    TrendPhraseSerializerv2:
      type: object
      properties:
        search_term:
          type: string
        display_name:
          type: string
      required:
      - display_name
      - search_term
    Interval:
      type: object
      properties:
        start:
          type: integer
        end:
          type: integer
      required:
      - end
      - start
    TrendResponseSerializerv2:
      type: object
      properties:
        time_step:
          type: integer
          description: Number of seconds in each window the timeframe was divided into
        first_timestamp:
          type: integer
        last_timestamp:
          type: integer
        trends:
          type: array
          items:
            $ref: '#/components/schemas/TrendEntrySerializerv2'
        epoch_articles:
          type: array
          items:
            type: integer
          description: The number of articles in each time_step
      required:
      - epoch_articles
      - first_timestamp
      - last_timestamp
      - time_step
      - trends
    TrendEntrySerializerv2:
      type: object
      properties:
        phrase:
          $ref: '#/components/schemas/TrendPhraseSerializerv2'
        significance:
          type: number
          format: double
        interval:
          $ref: '#/components/schemas/Interval'
        articles:
          type: array
          items:
            $ref: '#/components/schemas/ArticleIdsSerializerv2'
        epochs:
          type: array
          items:
            $ref: '#/components/schemas/TrendEpochSerializerv2'
        timestamp:
          type: integer
        burstiness:
          type: number
          format: double
      required:
      - articles
      - burstiness
      - epochs
      - interval
      - phrase
      - significance
      - timestamp
  securitySchemes:
    JWT:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "JWT"
    cookieAuth:
      type: apiKey
      in: cookie
      name: PHPSESSID
    ephmeralId:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Ephemeral"
    staticToken:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- opoint-openapi-original.yml
- opoint-openapi.yml