The Stream Api API from Lithium — 25 operation(s) for stream api.
openapi: 3.1.0
info:
title: agent-states-api-v2 AccountSet Stream Api API
version: '1.1'
servers:
- url: https://{instance}.response.lithium.com/api/v2/agentstate
variables:
instance:
default: instance
security:
- {}
tags:
- name: Stream Api
paths:
/{account}/{streamName}:
get:
summary: Retrieve Stream's Approved Content
description: Retrieve approved content for a specified account and stream
operationId: retrieve-streams-approved-content
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: streamName
in: path
schema:
type: string
required: true
- name: tweet_mode
in: query
description: This will expose the latest Tweet format from Twitter where the payload contains all information required to render Tweets that contain more than 140 characters.
schema:
type: string
default: extended
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?limit:
get:
summary: Specify amount of content to pull
description: Includes a query parameter to return a specific number of entities
operationId: specify-amount-of-content-to-pull
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: streamName
in: path
schema:
type: string
required: true
- name: limit
in: query
description: Number of status entities to return. **Maximum:** `200` **Minimum:** `1`
schema:
type: integer
format: int32
default: 50
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?since_id:
get:
summary: Gather content after specific entity
description: Includes only those status entities approved after supplied status entity_id biasing towards real-time
operationId: gather-content-after-specific-entity
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: since_id
in: query
description: Includes only those status entities approved after supplied status entity_id biasing towards real-time. (e.g. “entity_id” = 255682528302747648)"
schema:
type: string
default: '255682528302747648'
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?from_id:
get:
summary: Gather content after included entity
description: Includes only those status entities approved after supplied status entity_id without skipping over status entities
operationId: gather-content-after-included-entity
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: from_id
in: query
schema:
type: string
default: '255682528302747648'
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?start_id:
get:
summary: Gather content before included entity
description: Includes only those status entities approved before supplied status `entity_id`
operationId: gather-content-after-included-entity-1
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: start_id
in: query
description: Includes only those status entities approved before supplied status entity_id. This parameter is commonly used to implement ‘More’ functionality on a stream of content, wherein an end user sees a stream of content, then clicks on a ‘More’ link to display the next N entities. By supplying the entity_id of the last viewed entity, you may request the set of entities that came before it in the stream.
schema:
type: string
default: '255682528302747648'
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?callback:
get:
summary: Enable JSONP support
description: Enables JSONP support. Wraps JSON response with a JavaScript function of given name. (e.g. ?callback=myFunction)
operationId: enable-jsonp-support
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: streamName
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?geo_hint:
get:
summary: Enable geohinting data
description: Includes only those status entities approved before supplied status `entity_id`
operationId: enable-geohinting-data
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: geo_hint
in: query
description: When possible, geo_hint adds inferred status entity location from the authoring user’s profile information. The data is added the to geo_hint property of a Twitter status entity. (e.g. 1)
schema:
type: boolean
default: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"geo_hint\": {\n \"country\": \"US\",\n \"state\": \"CA\",\n \"coordinates\": [\n 34.0522342,\n -118.2436849\n ]\n }\n}"
schema:
type: object
properties:
geo_hint:
type: object
properties:
country:
type: string
example: US
state:
type: string
example: CA
coordinates:
type: array
items:
type: number
example: 34.0522342
default: 0
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?page_links:
get:
summary: Enable product hinting for each entity
description: Enable product hinting by specified account and stream
operationId: enable-product-hinting-for-each-entity
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: page_links
in: query
description: This parameter is used for Product Linking and must be set to true to surface up any product data that is linked to the entity. The absence of the parameter or it being set to false will assume that you are not requesting product linked data. If set to true, the data is added the to massrel/page_links property of an entity. (e.g. 1)
schema:
type: boolean
default: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"massrel\": {\n \"page_links\": [\n {\n \"id\": 12,\n \"url\": \"http://yoursite.com/yourpage\",\n \"short_url\": \"http://mssv.ly/13J39ai\",\n \"name\": \"Your page name\",\n \"description\": \"Your page description\",\n \"image_url\": \"http://yoursite.com/yourpage.jpg\"\n }\n ]\n }\n}"
schema:
type: object
properties:
massrel:
type: object
properties:
page_links:
type: array
items:
type: object
properties:
id:
type: integer
example: 12
default: 0
url:
type: string
example: http://yoursite.com/yourpage
short_url:
type: string
example: http://mssv.ly/13J39ai
name:
type: string
example: Your page name
description:
type: string
example: Your page description
image_url:
type: string
example: http://yoursite.com/yourpage.jpg
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?replies:
get:
summary: Enable replies to entities
description: Includes the status entity that a status entity replied to. The status entity is added to the in_reply_to property of a status entity
operationId: enable-replies-to-entities
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: replies
in: query
description: Includes the status entity that a status entity replied to. The status entity is added to the in_reply_to property of a status entity. (e.g. 1)
schema:
type: boolean
default: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"massrel\": {\n \"page_links\": [\n {\n \"id\": 12,\n \"url\": \"http://yoursite.com/yourpage\",\n \"short_url\": \"http://mssv.ly/13J39ai\",\n \"name\": \"Your page name\",\n \"description\": \"Your page description\",\n \"image_url\": \"http://yoursite.com/yourpage.jpg\"\n }\n ]\n }\n}"
schema:
type: object
properties:
massrel:
type: object
properties:
page_links:
type: array
items:
type: object
properties:
id:
type: integer
example: 12
default: 0
url:
type: string
example: http://yoursite.com/yourpage
short_url:
type: string
example: http://mssv.ly/13J39ai
name:
type: string
example: Your page name
description:
type: string
example: Your page description
image_url:
type: string
example: http://yoursite.com/yourpage.jpg
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?network:
get:
summary: Specify Social Network to gather entities
description: Includes entities from a specified social network only
operationId: specify-social-network-to-gather-entities
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: network
in: query
description: Includes entities from a specified social network only. **Possible Values:** `facebook`, `instagram`, `google_plus`, and `rss`. **Notes:** Must be a single value (`network=facebook`). Multiple values are not supported.
schema:
type: string
default: facebook
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?include_entities:
get:
summary: Included entity object on tweets
description: XML endpoint only. Includes an `entities` object on Tweets containing links, media, or other references
operationId: included-entity-object-on-tweets
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: include_entities
in: query
description: XML endpoint only. Includes an `entities` object on Tweets containing links, media, or other references.
schema:
type: boolean
default: true
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?reverse:
get:
summary: Reverse order of status entities
description: Reverses the status entities in response to be in chronological approved order (default is reverse chronological approved order) so that entities approved earlier are on top
operationId: reverse-order-of-status-entities
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: reverse
in: query
description: Reverses the status entities in response to be in chronological approved order (default is reverse chronological approved order) so that entities approved earlier are on top.
schema:
type: boolean
default: true
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?strip_links:
get:
summary: Remove trailing links
description: Removes trailing URLs from the text of a status entity
operationId: remove-trailing-links-1
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: strip_links
in: query
description: Removes trailing URLs from the text of a status entity.
schema:
type: boolean
default: true
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?keywords:
get:
summary: Gather specific entities containing keywords
description: Returns only entities containing the specified keywords
operationId: remove-trailing-links
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: keywords
in: query
description: Returns only entities containing the specified keywords.(e.g. `fire%20ice`)
schema:
type: string
default: fire%20ice
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?from:
get:
summary: Return entities from specific user
description: Returns only entities authored by the specified author. The value must be in all lowercase. (e.g. `jack%20johnson`)
operationId: return-entities-from-specific-user
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: from
in: query
schema:
type: string
default: jack%20johnson
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?timeframe[start]:
get:
summary: Return entities after a specific time
description: Returns only items created after given time. Only use the seconds portion of unix time (JavaScript will give the number in milliseconds. Divide by 1000). (e.g. `1380666060`)
operationId: return-entities-after-a-specific-time
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: timeframe[start]
in: query
schema:
type: string
default: '1380666060'
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}/{streamName}?timeframe[finish]:
get:
summary: Return entities before a specific time
description: Returns only items created before given time. Only use the seconds portion of unix time (JavaScript will give the number in milliseconds. Divide by 1000). (e.g. `1380666060`)
operationId: return-entities-before-a-specific-time
parameters:
- name: account
in: path
schema:
type: string
default: MassRelDemo
required: true
- name: streamName
in: path
schema:
type: string
default: kindle.json
required: true
- name: timeframe[finish]
in: query
schema:
type: string
default: '1380666060'
responses:
'200':
description: '200'
content:
text/plain:
examples:
Result:
value: Coming Soon
deprecated: false
security: []
tags:
- Stream Api
/{account}.json:
get:
summary: Get meta account information
description: Retrieves limited meta-information (entity counts, entity activity rates, etc.) about a set of streams belonging to an individual user account
operationId: get-meta-account-information
parameters:
- name: account
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"streams\": [\n {\n \"activity\": {\n \"minute\": {\n \"approved\": [\n 0,\n ...\n 0\n ],\n \"pending\": [\n 0,\n ...\n 0\n ],\n \"rejected\": [\n 0,\n ...\n 0\n ],\n \"total\": [\n 0,\n ...\n 0\n ]\n }\n },\n \"approved_tpm\": 0,\n \"count\": {\n \"approved\": 91617,\n \"pending\": 0,\n \"rejected\": 192724,\n \"total\": 284341\n },\n \"count_pct\": 91617,\n \"created_at\": \"2015-04-13T19:16:10Z\",\n \"description\": \"-nab2015\",\n \"full_name\": \"MassRelDemo/-nab2015\",\n \"name\": \"-nab2015\",\n \"tags\": [],\n \"tpm\": 0\n },\n ...\n }\n ]\n}"
deprecated: false
security: []
tags:
- Stream Api
/{account}.json?streams:
get:
summary: Get meta info of account's streams
description: Returns a comma-delimited set of stream names for which you need to pull meta information
operationId: get-meta-info-of-accounts-streams
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: streams
in: query
schema:
type: string
default: galaxy-topic
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"streams\": [\n {\n \"activity\": {\n \"minute\": {\n \"approved\": [\n 0,\n ...\n 0\n ],\n \"pending\": [\n 0,\n ...\n 0\n ],\n \"rejected\": [\n 0,\n ...\n 0\n ],\n \"total\": [\n 0,\n ...\n 0\n ]\n }\n },\n \"approved_tpm\": 0,\n \"count\": {\n \"approved\": 12990,\n \"pending\": 0,\n \"rejected\": 0,\n \"total\": 12990\n },\n \"count_pct\": 12990,\n \"created_at\": \"2012-02-03T15:17:01Z\",\n \"description\": \"Topic 1\",\n \"full_name\": \"MassRelDemo/galaxy-topic1\",\n \"name\": \"galaxy-topic1\",\n \"tags\": [],\n \"tpm\": 0\n },\n ...\n }\n ]\n}"
deprecated: false
security: []
tags:
- Stream Api
/{account}.json?num_minutes:
get:
summary: Get minutes of activity from account
description: Retrieves the number of minutes of activity.
operationId: get-minutes-of-activity-from-account
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: num_minutes
in: query
schema:
type: integer
format: int32
default: 120
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"streams\": [\n {\n \"activity\": {\n \"minute\": {\n \"approved\": [\n 0,\n ...\n 0\n ],\n \"pending\": [\n 0,\n ...\n 0\n ],\n \"rejected\": [\n 0,\n ...\n 0\n ],\n \"total\": [\n 0,\n ...\n 0\n ]\n }\n },\n \"approved_tpm\": 0,\n \"count\": {\n \"approved\": 91617,\n \"pending\": 0,\n \"rejected\": 192724,\n \"total\": 284341\n },\n \"count_pct\": 91617,\n \"created_at\": \"2015-04-13T19:16:10Z\",\n \"description\": \"-nab2015\",\n \"full_name\": \"MassRelDemo/-nab2015\",\n \"name\": \"-nab2015\",\n \"tags\": [],\n \"tpm\": 0\n },\n ...\n }\n ]\n}"
deprecated: false
security: []
tags:
- Stream Api
/{account}.json?num_trends:
get:
summary: Get trends in response per account
description: Number of trends to return in response per bucket
operationId: get-trends-in-response-per-account
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: num_trends
in: query
schema:
type: integer
format: int32
default: 5
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"streams\": [\n {\n \"activity\": {\n \"minute\": {\n \"approved\": [\n 0,\n ...\n 0\n ],\n \"pending\": [\n 0,\n ...\n 0\n ],\n \"rejected\": [\n 0,\n ...\n 0\n ],\n \"total\": [\n 0,\n ...\n 0\n ]\n }\n },\n \"approved_tpm\": 0,\n \"count\": {\n \"approved\": 91617,\n \"pending\": 0,\n \"rejected\": 192724,\n \"total\": 284341\n },\n \"count_pct\": 91617,\n \"created_at\": \"2015-04-13T19:16:10Z\",\n \"description\": \"-nab2015\",\n \"full_name\": \"MassRelDemo/-nab2015\",\n \"name\": \"-nab2015\",\n \"tags\": [],\n \"tpm\": 0\n },\n ...\n }\n ]\n}"
deprecated: false
security: []
tags:
- Stream Api
/{account}.json?disregard:
get:
summary: Exclude specified trends
description: Exclude trends that match supplied values from buckets while trying to ensure `num_trends` is met
operationId: exclude-specified-trends
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: disregard
in: query
schema:
type: string
default: test
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
security: []
tags:
- Stream Api
/{account}.json?start:
get:
summary: Get activity data from specific time
description: Unix time of the point of which activity data should start
operationId: get-activity-data-from-specific-time
parameters:
- name: account
in: path
schema:
type: string
required: true
- name: start
in: query
schema:
type: integer
format: int32
default: 1349278694
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"streams\": [\n {\n \"activity\": {\n \"minute\": {\n \"approved\": [\n 0,\n ...\n 0\n ],\n \"pending\": [\n 0,\n ...\n 0\n ],\n \"rejected\": [\n 0,\n ...\n 0\n ],\n \"total\": [\n 0,\n ...\n 0\n ]\n }\n },\n \"approved_tpm\": 0,\n \"count\": {\n \"approved\": 91617,\n \"pending\": 0,\n \"rejected\": 192724,\n \"total\": 284341\n },\n \"count_pct\": 91617,\n \"created_at\": \"2015-04-13T19:16:10Z\",\n \"description\": \"-nab2015\",\n \"full_name\": \"MassRelDemo/-nab2015\",\n \"name\": \"-nab2015\",\n \"tags\": [],\n \"tpm\": 0\n },\n ...\n }\n ]\n}"
deprecated: false
security: []
tags:
- Stream Api
/{account}.json?finish:
get:
summary: Get activity data ending at specific time
description: Unix time of the point of which activity data should end
operationId: get-activity-data-ending-at-specific-time
parameters:
- name: account
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"streams\": [\n {\n \"activity\": {\n \"minute\": {\n \"approved\": [\n 0,\n ...\n 0\n ],\n \"pending\": [\n 0,\n ...\n 0\n ],\n \"rejected\": [\n 0,\n ...\n 0\n ],\n \"total\": [\n 0,\n ...\n 0\n ]\n }\n },\n \"approved_tpm\": 0,\n \"count\": {\n \"approved\": 91617,\n \"pending\": 0,\n \"rejected\": 192724,\n \"total\": 284341\n },\n \"count_pct\": 91617,\n \"created_at\": \"2015-04-13T19:16:10Z\",\n \"description\": \"-nab2015\",\n \"full_name\": \"MassRelDemo/-nab2015\",\n \"name\": \"-nab2015\",\n \"tags\": [],\n \"tpm\": 0\n },\n ...\n }\n ]\n}"
deprecated: false
security: []
tags:
- Stream Api
/{account}.json?streams_with_topics:
get:
summary: Get streams with/without topics
description: Returns streams that do or do not have topics configured
operationId: get-streams-withwithout-topics
parameters:
- name: account
in
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lithium/refs/heads/main/openapi/lithium-stream-api-api-openapi.yml