Oktopost API Reference

Campaigns

Oktopost campaigns
Parameter
<withTags> (optional): Includes the campaign tags in the response
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Id	string	Campaign Id
Name	string	Name of campaign
TotalPosts	integer	Total Posts
TotalPendingPosts	integer	Total Pending Posts
TotalDraftPosts	integer	Total Draft Posts
Click	integer	Click
Converts	integer	Converts
Created	timestamp	Timestamp indicating when this campaign is created
Status	string	Status of campaign
Comments	integer	Comments
PostsSent	integer	Posts Sent

SQL

CREATE OR REPLACE View oktopost_examples.example_Campaigns
As 
Select * From oktopost_t2.Campaigns (
	preview => true
)

CampaignsExteneded

Oktopost campaigns exteneded
Parameter
<withTags> (optional): Includes the campaign tags in the response
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Id	string	Campaign Id
Name	string	Name of campaign
TotalPosts	integer	Total Posts
TotalPendingPosts	integer	Total Pending Posts
TotalDraftPosts	integer	Total Draft Posts
Click	integer	Click
Converts	integer	Converts
Created	timestamp	Timestamp indicating when this campaign is created
Status	string	Status of campaign
Comments	integer	Comments
PostsSent	integer	Posts Sent
Modified	timestamp	Timestamp indicating when this campaign is modified
AccountId	string	Account Id
CreatedBy	string	Created By
ModifiedBy	string	Modified By
Url	string	Url
Color	string	Color
ShortUrl	string	Short Url
StartDate	timestamp	Start Date
EndDate	timestamp	End Date
LastConversionDate	timestamp	Last Conversion Date
LastCommentFound	timestamp	Last Comment Found
SendSummary	string	Send Summary
ChildClicks	integer	Child Clicks
BoardClicks	integer	Board Clicks
ChildConverts	integer	Child Converts
BoardConverts	integer	Board Converts
NewComments	integer	New Comments
Likes	integer	Likes
TotalMessages	integer	Total Messages
SFDCCampaignId	string	SFDC Campaign Id
SFDCCampaignName	string	SFDC Campaign Name
SFDCCampaignOption	string	SFDC Campaign Option
Utm	string	Utm

SQL

CREATE OR REPLACE View oktopost_examples.example_CampaignsExteneded
As 
Select * From oktopost_t2.CampaignsExteneded (
	preview => true
)

PostAnalytics

Post Analytics
Parameter
<postAge> (required): Count of days from which we select posts analytics
<postId> (optional): Post Id
<post_table> (optional): Table name with post data
<discardHistory> (optional): Leave only most recent data per post
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportDate	date	Report date
postId	string	Post id
LinkClicks	integer	Count of link click
Conversions	integer	Quantity of conversions
Comments	integer	Count of comments
Likes	integer	Count of likes
Shares	integer	Count of shares
ImpressionsAdded	integer	Quantity of added impressions
MediaClicksAdded	integer	Media Clicks Added
UserFollowsAdded	integer	User Follows Added
Reach	integer	Reach
DetailExpandsAdded	integer	Detail Expands Added

SQL

CREATE OR REPLACE View oktopost_examples.example_PostAnalytics
As 
Select * From oktopost_t2.PostAnalytics (
	postAge => 1,
	preview => true
)

Posts

Posts from the account
Parameter
<messageId> (optional): Return single item, rather than list
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Id	string	Post Id
Created	timestamp	Timestamp indicating when this post is created
Modified	timestamp	Timestamp indicating when this post is modified
Status	string	Status
AccountId	string	Account Id
CreatedBy	string	Created By
ModifiedBy	string	Modified By
Source	string	Source
ContentSource	string	Content Source
Queued	string	Queued
CampaignId	string	Campaign Id
BoardId	string	Board Id
MessageId	string	Message Id
MessageChildId	string	Message ChildId
MessageStatus	string	Message Status
Network	string	Network
StartDateTime	timestamp	Start DateTime
Groups	string	Groups
GroupsCount	integer	Groups Count
TotalCount	integer	Total Count
TargetGeo	string	Target Geo
UpdateStatus	string	Update Status
Flag	string	Flag
Clicks	integer	Clicks
Converts	integer	Converts
Comments	integer	Comments
NewComments	integer	New Comments
Likes	integer	Likes
Utm	string	Utm
ApproveStatus	string	Approve Status
Credentials	string	Credentials

SQL

CREATE OR REPLACE View oktopost_examples.example_Posts
As 
Select * From oktopost_t2.Posts (
	preview => true
)

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefixes in their names.

Campaigns

Oktopost campaigns
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table

Attribute	Type	Description
Id	string	Campaign Id
Name	string	Name of campaign
TotalPosts	integer	Total Posts
TotalPendingPosts	integer	Total Pending Posts
TotalDraftPosts	integer	Total Draft Posts
Click	integer	Click
Converts	integer	Converts
Created	timestamp	Timestamp indicating when this campaign is created
Status	string	Status of campaign
Comments	integer	Comments
PostsSent	integer	Posts Sent

Example

SQL

CREATE VIEW oktopost_examples.example_Campaigns
AS 
SELECT * FROM oktopost.Campaigns (
	preview => TRUE
)

PostAnalytics

Post Analytics
Parameter
<postAge> (required): Count of days from which we select posts analytics
<post_table> (optional): Table name with post data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table

Attribute	Type	Description
reportDate	date	Report date
postId	string	Post id
LinkClicks	integer	Count of link click
Conversions	integer	Quantity of conversions
Comments	integer	Count of comments
Likes	integer	Count of likes
Shares	integer	Count of shares
ImpressionsAdded	integer	Quantity of added impressions

Example

SQL

CREATE VIEW oktopost_examples.example_PostAnalytics
AS 
SELECT * FROM oktopost.PostAnalytics (
	postAge => 1,
	preview => TRUE
)

Posts

Posts from the account
Parameter
<messageId> (optional): Return single item, rather than list
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table

Attribute	Type	Description
Id	string	Post Id
Created	timestamp	A timestamp indicating when this post is created
Modified	timestamp	A timestamp indicating when this post is modified
Status	string	Status
AccountId	string	Account Id
CreatedBy	string	Created By
ModifiedBy	string	Modified By
Source	string	Source
ContentSource	string	Content Source
Queued	string	Queued
CampaignId	string	Campaign Id
BoardId	string	Board Id
MessageId	string	Message Id
MessageChildId	string	Message ChildId
MessageStatus	string	Message Status
Network	string	Network
StartDateTime	timestamp	Start DateTime
Groups	string	Groups
GroupsCount	integer	Groups Count
TotalCount	integer	Total Count
TargetGeo	string	Target Geo
UpdateStatus	string	Update Status
Flag	string	Flag
Clicks	integer	Clicks
Converts	integer	Converts
Comments	integer	Comments
NewComments	integer	New Comments
Likes	integer	Likes
Utm	string	Utm
ApproveStatus	string	Approve Status
Credentials	string	Credentials

Example

SQL

CREATE VIEW oktopost_examples.example_Posts
AS 
SELECT * FROM oktopost.Posts (
	preview => TRUE
)