Streams

Streams are live feeds that display and engage with the content from connected social profiles. With this endpoint you can view, add, edit and remove streams from a users' account.

List Streams

Order by position or created

Example Request

curl -i https://api.oktopost.com/v2/stream \ 
	-d position=420

Example Response

{
	"Result": true,
	"Items":
	[
		{
			"Id": "00F00000000000",
			"Created": "2020-11-19 08:22:01",
			"Name": "#b2b",
			"Network": "Twitter",
			"Type": "tw.keyword",
			"StreamTabId": "01800000000000",
			"CredentialId": "003-001000000000000-10795428XXXXXXXXX",
			"Position": 2
		},
		{
			"Id": "00F00000000001",
			"Created": "2020-11-09 18:00:01",
			"Name": "#btc",
			"Network": "Twitter",
			"Type": "tw.keyword",
			"StreamTabId": "01800000000000",
			"CredentialId": "003-001000000000000-10795428XXXXXXXXX",
			"Position": 3
		}
	]
}

Create Stream

Parameters

Param	Description
network	Facebook, Twitter, LinkedIn, or Instagram.
credentialId	The Social Profile Id.
type	The stream type, see acceptable values below.
keyword	The search term.

Twitter Streams

Type	Description
mention	Mentions of a connected Twitter handle.
retweet	Tweets that users retweeted.
feed	Tweets by a connected Twitter handle.
keyword	A feed that searches Twitter for keywords.
list	A feed with all the tweets by handles on a Twitter List.
favorite	Tweets that users liked.
home	The home feed of a connected Twitter handle.
user	A feed with tweets by any Twitter handle.

Instagram Streams

Type	Description
page	Posts from a connected Instagram page.
page.tags	Posts containing a specific hashtag.

Facebook Streams

Type	Description
ownpage	Posts from a connected Facebook page.
tag	Posts that mention a connected Facebook page.

LinkedIn Streams

Type	Description
page	Posts from a connected LinkedIn page.

Example Request

Create a stream with mentions of a connected Twitter handle.

curl -i https://api.oktopost.com/v2/stream -X POST \
	-d streamTabId=01800000000000 \
	-d network=Twitter \
	-d credentialId=003-001000000000000-10795428XXXXXXXXX \
	-d type=mention \
	-d position=-2

Create a stream that searches Twitter for specific terms or keywords. See search options.

curl -i https://api.oktopost.com/v2/stream -X POST \
	-d streamTabId=01800000000000 \
	-d network=Twitter \
	-d credentialId=003-001000000000000-10795428XXXXXXXXX \
	-d type=keyword \
	-d keyword="#haiku" \
	-d position=2

Example Result

{
	"Result": true,
	"Stream": 
	{
		"Id": "00F00000000000",
		"Created": "2020-11-19 08:22:01",
		"Name": "last",
		"Network": "Twitter",
		"Type": "tw.keyword",
		"StreamTabId": "01800000000000",
		"CredentialId": "003-001000000000000-10795428XXXXXXXXX",
		"Position": 2
	}
}

Remove Stream

curl -i https://api.oktopost.com/v2/stream/00F000000000001 -X DELETE

Example Result

{
	"Result": true
}

Update Stream Position

curl -i https://api.oktopost.com/v2/stream/01800000000000 -X POST \
	-d position=420

Example Result

{
	"Result": true,
	"Stream": 
	{
		"Id": "00F00000000000",
		"Created": "2020-11-19 08:22:01",
		"Name": "last",
		"Network": "Twitter",
		"Type": "tw.keyword",
		"StreamTabId": "01800000000000",
		"CredentialId": "003-001000000000000-10795428XXXXXXXXX",
		"Position": 2
	}
}

On this page