Lithium

Lithium Streams API

The Streams API from Lithium — 1 operation(s) for streams.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.khoros.com/khoroscaredevdocs/docs/khoros-care-integration-overview
📖
Documentation
https://developer.khoros.com/khorosmarketingdevdocs/docs/developing-and-integrating-with-khoros-marketing
📖
Documentation
https://developer.khoros.com/khoros-flow/docs/overview-of-khoros-flow-apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lithium/refs/heads/main/openapi/lithium-streams-api-openapi.yml

OpenAPI Specification

lithium-streams-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: agent-states-api-v2 AccountSet Streams API
  version: '1.1'
servers:
- url: https://{instance}.response.lithium.com/api/v2/agentstate
  variables:
    instance:
      default: instance
security:
- {}
tags:
- name: Streams
paths:
  /streams:
    get:
      summary: 'Streams: List All Available Streams for a Company'
      description: Returns a list of the available streams for a given Company Directory ID
      operationId: list-all-available-streams-for-a-company
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n  {\n    \"campaign_id\": 1710,\n    \"credential_id\": 0,\n    \"hash\": \"c4ad3d29f2c80eea1c557a817581f04a\",\n    \"id\": 22910,\n    \"inbox\": false,\n    \"mode\": \"standard\",\n    \"name\": \"All Activity\",\n    \"query\": \"\",\n    \"stream_type\": \"spredfast\",\n    \"user_id\": 73208\n  },\n  {\n    \"campaign_id\": 1710,\n    \"credential_id\": 0,\n    \"hash\": \"17d10dfe348ab18a449858e836f59a7f\",\n    \"id\": 22911,\n    \"inbox\": false,\n    \"mode\": \"user_engagement\",\n    \"name\": \"Recent Engagement\",\n    \"query\": \"\",\n    \"stream_type\": \"spredfast\",\n    \"user_id\": 73208\n  }\n]"
              schema:
                type: array
                items:
                  type: object
                  properties:
                    campaign_id:
                      type: integer
                      example: 1710
                      default: 0
                    credential_id:
                      type: integer
                      example: 0
                      default: 0
                    hash:
                      type: string
                      example: c4ad3d29f2c80eea1c557a817581f04a
                    id:
                      type: integer
                      example: 22910
                      default: 0
                    inbox:
                      type: boolean
                      example: false
                      default: true
                    mode:
                      type: string
                      example: standard
                    name:
                      type: string
                      example: All Activity
                    query:
                      type: string
                      example: ''
                    stream_type:
                      type: string
                      example: spredfast
                    user_id:
                      type: integer
                      example: 73208
                      default: 0
        '403':
          description: '403'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      security: []
      tags:
      - Streams
x-readme:
  headers: []
  explorer-enabled: false
  proxy-enabled: false
x-readme-fauxas: true