API Social Radian6

Social Studio API Developer's
Guide
Version 35.0, Winter 16
@salesforcedocs
Last updated: December 8, 2015
Copyright 20002015 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,
as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS
GETTING STARTED WITH THE SOCIAL STUDIO API . . . . . . . . . . . . . . . . . . . . 1

Chapter 1: Introducing Social Studio REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Enable API Applications for your Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Authorization Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Requesting an Access Token (Resource Owner Password) . . . . . . . . . . . . . . . . . . . . . . . 7
Make Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Refresh the Access Token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Revoking an Access Token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
GENERAL DEVELOPER INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Chapter 2: Rate Limiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Response Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
METHODS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 3: Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Retrieve Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Create Author Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Delete Author Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Delete Author Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Create Comment for Author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Retrieve Comment for Author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Delete Author Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Chapter 4: Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Retrieve Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Chapter 5: Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Retrieve Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Retrieve User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Create User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Update User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Reset Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Modify Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 6: Workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Retrieve Workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Contents
Retrieve Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Create Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Update Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Delete Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Create Workspace Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Delete Workspace Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Chapter 7: Imported Posts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Retrieve Posts & Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 8: Shared Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Retrieve Shared Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Share & Unshare Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Create Shared Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Archive & Unarchive Shared Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Delete Shared Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Chapter 9: Short URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Retrieve Short URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Retrieve Short URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Create Short URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Delete Short URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Chapter 10: Publish Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Retrieve Publish Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Retrieve Publish Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Retrieve Publish Macro Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Create Publish Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Delete Publish Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Chapter 11: Approval Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Retrieve Approval Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Retrieve Approval Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Create Approval Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Update Approval Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Delete Approval Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Retrieve Approval Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Update Approval Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Retrieve Approvers for a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Update Approvers for a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Chapter 12: Social Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Retrieve Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Retrieve Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Chapter 13: Create Topic Profile and Retrieving Posts with Keyword Groups . . . . . . . 126
Contents
Retrieve Topic Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Retrieve Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Create Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Update Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Delete Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Update Keyword Groups in a Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Delete Keyword Groups in a Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Update Source Filters in a Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Activate a Topic Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Chapter 14: Keyword Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Retrieve Keyword Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Create Keyword Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Update Keyword Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Chapter 15: Sources and Source Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Retrieve Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Retrieve Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Create Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Update Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Delete Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Retrieve Source Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Retrieve Source Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Create Source Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Update Source Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Delete Source Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Chapter 16: Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Retrieve Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Retrieve Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Chapter 17: Regions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Retrieve Regions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Retrieve Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Chapter 18: Media Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Retrieve Media Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Retrieve Media Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Chapter 19: Posts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Retrieve Posts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Chapter 20: Engage Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Retrieve Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Retrieve Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Contents
Create Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Update Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Execute Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Delete Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Retrieve SalesforceOrgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Retrieve SalesforceOrg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
GETTING STARTED WITH THE SOCIAL STUDIO API
CHAPTER 1 Introducing Social Studio REST API

In this chapter ... Available in: All editions.
The Social Studio API is a REST-ful web service for retrieving, analyzing, and modifying social media data
Enable API
Applications for your
contained in your Social Studio Account.
Organization Clients may use the Social Studio API to extend the functionality of the Social Studio. For example: extract
Authentication post data & insights directly from your Social Accounts and Topic Profiles, access post metadata such as
post tags and source tags, and manage the setup and configuration within your Social Studio Organization.
The API may be used to integrate with any internal system, CRM, or Business Intelligence tool. Clients
may use it to create custom internal reporting, to integrate with intranets, and to quickly disseminate
information throughout the organization. Other uses include creating custom reports for clients, enhancing
the value of client applications and services, or to drive web and mobile applications.
RESTful API using HTTP verbs
Authenticate using OAuth 2.0
HTTPS only
API requests and responses serialized as JSON
Provides access to Social Studio functionality
1
Introducing Social Studio REST API Enable API Applications for your Organization
Enable API Applications for your Organization

Before you utilize the Social Studio REST API, you must enable and register your API application:
This step ensures your organization can accept API calls.
1. Log in as a super user or organization administrator to
https://socialstudio.radian6.com/admin#organizationSettings.
2. Navigate to the Admin section and click on Organization Settings.
3. Select the Developers can create API Applications checkbox under the API Applications heading.
2
Register an API Application in Social Studio

This step creates a new application for use with Social Studio and provides an application key and secret for use in retrieving an OAuth
access token.
1. Navigate to the Admin section in Social Studio.
2. Click on the API Applications section.
3. Click Add New.
4. Review the Marketing Cloud Social API Usage Agreement and click I Accept the Terms and Conditions.
3
5. Enter the details for your new API application: Name Application Description Callback URL
4
Introducing Social Studio REST API Authentication
6. Click Save.
7. To view the details of your application, find it in the applications list and click on it. A dialog will appear on the left side of your screen
that contains all of your application details.
Authentication
You can receive the client key and secret issued for the application via self-serve by a Social Studio super user or an administration by
logging into socialstudio.radian6.com/admin. When creating the credentials for the application, you must specify the redirect URL for
the application. The authentication server will redirect the user to this URL with an authorization code.
Supported Flows
Social Studio currently supports the following OAuth flows:
5
Introducing Social Studio REST API Authorization Code
Authorization (web server flow)

Implicit grant (client-side applications)
Resource owner password-based grant (trusted applications)
IN THIS SECTION:
Authorization Code
Requesting an Access Token (Resource Owner Password)
Make Requests
Refresh the Access Token
Revoking an Access Token
Authorization Code
This authentication method redirects the user to an authorization page, which permits the user to grant authorization to the application
to act. The page displays a login prompt with the message Please log in to grant access to the application. Once the user logs in and grants
access, the page will redirect the user to the application redirect URL as specified when generating their client credentials.
Authorization URL: https://api.socialstudio.radian6.com/login/oauth/authorize
Request
Query String Parameter Value
client_id The application client key
response_type Either one of the following two elements: code - Server-side

applications use this web service flow. After authentication, the
browser redirects back to the application redirect URL with an
authorization code on the query string used to request a refreshable
access token. token - Client-side applications use this implicit
(client-credentials) flow. This process does not store an access
token. Instead, the call returns the token as part of the URL
fragment.
state A unique value included in the redirect call that maintains the state
between the request and the response
redirect_url
Response
The call returns the repsonse of this endpoint to the client application be redirecting back to their returned URL with certain query string
parameters set.
6
Introducing Social Studio REST API Requesting an Access Token (Resource Owner Password)
Web Server Flow

After the user successfully logs in, the call redirects them to the following URL:
{redirectUrl}?code={authorizationCode}&scope=OOB&state={state}
*redirectUrl* - the call specifies this value when creating the client credentials.
*authorizationCode* - the application can handle the authorizationCode as outlined in the
section *Requesting an Access Token*.
*state* - use thestate value you specified in your requests.
*scope* - at present, we do not support specific scopes, so use the default value of OOB
Requesting an Access Token (Resource Owner Password)

This flow includes implied authorization because the resource owner conducts the call. Use this flow only for highly trusted clients, as
the process exposes the user password to the client. You only need to send the password once to receive a refresh token. Store the
refresh token for further requests.
Request
POST /oauth/token HTTP/1.1
Host: api.socialstudio.radian6.com
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded
grant_type=password&client_id={clientKey}&client_secret={clientSecret}&username={r6username}&password={r6password}
*authorizationCode - code returned by following the instructions in the *Authorization

Code* section.
*client_key - client key included in client credentials for the application
*client_secret* - client secret included in the client credentials for the application
*r6username* - username in Social Studio
*r6password* - password in Social Studio
cURL Example
curl -X POST -H "Cache-Control: no-cache" -H "Content-Type:
application/x-www-form-urlencoded" -d
'grant_type=password&client_id=your_marketing_cloud_api_key&client_secret=your_marketing_cloud_api_secret&username=your_r6_username&password=your_r6_password'
'https://api.socialstudio.radian6.com/oauth/token'
Response
{
"access_token": "bc0fb4f7-2f51-4aa6-9192-f559e481e02f",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "d0e05be9-fb84-4dfb-93a5-8d781024cdc8",
7
Introducing Social Studio REST API Make Requests
"scope": "oob"
}
*access_token* - value used to make requests (as shown in the *Make Requests* section)
*expiresIn* - number of seconds before the token expires
*refresh_token* - value to save and use to refresh the access token (as shown in the
*Refresh the Access Token* section)
Make Requests
You can use a new API host that supports Oauth:
api.socialstudio.radian6.com
Requests to this URL require only an access token and do not require an auth_token or auth_appkey value.
Request
GET {host}v3/user/me HTTP/1.1
Connection: keep-alive
Accept: text/html,application/xhtml+xml,application/json;q=0.9,*/*;q=0.8
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8
access_token: 5545b2f1-9a8e-4bdd-a2ee-9d0c70f8fb08
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Request-ID: IsZ0g0ryksn0Cvk6
Content-Encoding: gzip
Content-Type: application/json
Content-Length: 156
Date: Tue, 18 Jun 2013 19:49:02 GMT
{
"data": [
{
"id": "7914",
"username": "john.doe@domain.com",
"displayName": "John Doe",
"email": "john.doe@domain.com",
"timeZone": "America/Halifax",
"enabled": true,
"orgRoleId": 1,
"languageId": 1,
"createdDate": "2014-10-27T14:41:48Z",
"internalUserAvatarUrl": null,
"userAvatarUrl": null,
"clientId": 1
}
],
"meta": {
8
Introducing Social Studio REST API Refresh the Access Token
"totalCount": 1
}
}
Alternatively, you can supply the access token using the header (188+):
Authorization: Bearer {access_token}
cURL Example
curl -X GET -H "access_token: your_access_token" -H "Cache-Control: no-cache"
'https://api.socialstudio.radian6.com/v3/users/me'
Refresh the Access Token

The Social Studio API will respond with the following message after token expiration, revocation, or any other issue leading to an invalid
token:
HTTP/1.1 401 Unauthorized

Date: Wed, 04 Nov 2015 18:07:59 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 279
{
"error": {
"message": "Validation error",
"statusCode": 401,
"errorCode": "MC-Unknown",
"requestId":"9a135ab7-9e56-49d7-8c1d-7805f2df6ee1"
},
"meta": null
}
An application can wait for this error message and then attempt to refresh the token, or it can use the expires_in time that comes with
the access token to determine when the token needs to be refreshed. The token can be refreshed at any time.
The end point for refreshing an access token is the same as that for requesting an access token, but uses slightly different parameters.
api.socialstudio.radian6.com/oauth/token
Request
POST /oauth/token HTTP/1.1
Content-Length: 169
Accept: */*
grant_type=refresh_token&refresh_token={refreshToken}&client_id={clientKey}&client_secret={clientSecret}
9
Introducing Social Studio REST API Revoking an Access Token
In this case, the grant_type is refresh_token and instead of supplying a code the parameter is refresh_token.
Response
If the refresh token has been revoked by the user or has become invalid for some other reason, then the refresh call will fail with the
following error:
HTTP/1.1 400 Bad Request

Date: Wed, 04 Nov 2015 18:12:16 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 78
Connection: close
{
"error":"invalid_request",
"error_description":"Invalid refresh token"
}
Revoking an Access Token

The user can revoke the access token and the refresh token using the access_token value.
Request
GET /oauth/revoke?access_token={access_token} HTTP/1.1
Accept: */*
Response
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Type: text/xml;charset=UTF-8
Content-Length: 31
Date: Wed, 07 Aug 2013 18:29:04 GMT
<revoked />
10
GENERAL DEVELOPER INFO
CHAPTER 2 Rate Limiting

In this chapter ... The Social Studio API will subject users who make too many calls too quickly to rate limiting. This measure
helps to ensure a single misbehaving application cannot produce excessive load and cause a degradation
Response Headers in performance for other applications.
Rate limiting breaks calls to the API into two types:
Relatively expensive calls that need to scan large indexes can make 700 requests per hour per user. GET
/v3/posts. *Less expensive API calls can make 900 requests per hour per user.
11
Rate Limiting Response Headers
Response Headers
The Social Studio API sends additional headers containing rate limit information with each response. These headers help track application
usage and quotas.
*X-RateLimit-Limit* - limit for the current endpoint type

*X-RateLimit-Remaining* - number of requests remaining for the current endpoint type
in the current timeframe
*X-RateLimit-Reset* - number of seconds until the limit period expires and the API
resets the limit to the number found in the *X-RateLimit-Limit* header
12
METHODS
CHAPTER 3 Authors
In this chapter ... The Authors endpoint allows you to get detailed information on an author. You can also apply additional
metadata by adding and managing tags and notes associated with those authors. Use author tags to
Retrieve Authors identify VIP customers, promoters, or detractors of a brand. Use notes to record additional important
Create Author Tag information on an author record.
Delete Author Tag
Delete Author Tags
Retrieve an Author
Create Comment for
Author
You can retrieve information on an author using the following call:
Retrieve Comment
for Author GET /v3/authors/{id}
Delete Author
Comment
cURL Example
curl -X GET -H "access_token: 0682240d-f531-4dc1-a9a6-c80eba9cb533"
'https://api.socialstudio.radian6.com/v3/authors/36221001'
Retrieve Author Tags

Add author tags using the following call:
POST /v3/authors/{id}/tags
cURL Example
curl -X POST -H "access_token: 0682240d-f531-4dc1-a9a6-c80eba9cb533"
-H "Content-Type: application/json" -d '{
"value":"VIP"
}' 'https://api.socialstudio.radian6.com/v3/authors/36221001/tags'
Delete Author Tags

Delete author tags using the following call:
DELETE /v3/authors/{id}/tags
13
Authors
cURL Example
curl -X DELETE -H "access_token: 0682240d-f531-4dc1-a9a6-c80eba9cb533"
"value":"VIP"
}'
'https://api.socialstudio.radian6.com/v3/authors/36221001/tags/6265'
14
Authors Retrieve Authors
Retrieve Authors
This method retrieves the specified author.
/v3/authors/{id}
HTTP method
GET
Request Parameters
*id* - string value indicating the author of a post (required)
Request Parameter Example

GET /v3/authors/{id}
Sample Request
GET /v3/authors/{id}
Sample Response
A successful call returns the following response:
{
"data": [
{
"id": "2184",
"title": "R6APITestUser1",
"externalId": "429245766",
"externalLegacyId": null,
"authorFullName": "API 1 APIQE ",
"avatar": "http://pbs.twimg.com/profile_images/1815149549/b-410745-
animated_dog_normal.jpg",
"authorTags": [
{
"id": "13434",
"value": "Sample tag"
}
],
"authorComments": [
{
"id": "454545",
"value": "Sample note"
}
15
Authors Create Author Tag
],
"bio": "Sample bio ",
"verified": false,
"authorData": {
"blogId": "62550515"
}
}
],
"meta": {
"totalCount": 1
}
}
*id* - string value indicating author

*title* - string value indicating author title
*externalid* - string value indicating ID for author on external platform
*externalLegacyId* - string value indicating any other external platform identifier for
author
*authorFullName* - string value indicating any available full name for author
*avatar* - string value indicating URL for avatar image file
*authorTags* - array containing ID and value pairs for tags associated with author
*authorComments* - array containing ID and value pairs for comments associated with author
*bio* - string value containing bio information for author from external platform
*verified* - boolean value indicating verified status for Twitter
*authorData* - array containing additional information on author, such as blogID
A call referencing a nonexistent author returns a 404 error.

A call that encounters an internal error while retrieving the author returns a 500 error.
Create Author Tag

This method adds a tag value to an author object within your Social Studio organization. You can add a single tag in a call or pass a array
of multiple tag values
/v3/authors/{authorId}/tags
HTTP Method
POST
Request Parameters
*authorId* - Integer value indicating the ID of the specific author (required)
Request Parameters Example

POST /v3/authors/{authorId}/tags
16
Authors Create Author Tag
JSON Parameters
*value* - string value including the tag value to apply to the author
Sample Request
The call below passes a single tag to the author.
POST /v3/authors/1/tags
{
"value":"vino"
}
The call below passes an array of tags to the author.

POST /v3/authors/1/tags
[{
"value": "Some Tag Value 1"
},
{
},
{
}]
Sample Response
A successful call returns a 201 code with a Location header for the location of the new tag and an ID value. If you pass an array of tags,
that response will include a Location header and an array of IDs for the tags.
[
{
"id": "154"
},
{
"id": "155"
},
{
"id": "156"
}
]
A call including an invalid JSON object will return a 400 code. Ensure you correctly formed the JSON object.
A call referencing an invalid author ID will return a 404 code. Ensure you referenced the correct author value.
A duplicate tag returns a 409 code. Ensure you include a unique tag value in your call.
17
Authors Delete Author Tag
Delete Author Tag

This method deletes a tag value for an author object within your Social Studio organization.
/v3/authors/{authorId}/tags/{tagId}
HTTP Method
DELETE
Request Parameters

*tagId* - Integer value indicating the ID of the specific tag (required)

DELETE /v3/authors/{authorId}/tags/{tagId}
Sample Request
DELETE /v3/authors/12345/tags/123
Sample Response
A successful call returns a 204 code.
A call referencing an invalid author ID or tag ID will return a 404 code. Ensure you referenced the correct values.
A internal error during creation returns a 500 Internal Server Error. Try your create call again at a later time.
Delete Author Tags

This method deletes all tag values associated with an author object within your Social Studio organization.
/v3/authors/{authorId}/tags
HTTP Method
DELETE
18
Authors Create Comment for Author
Request Parameters

DELETE /v3/authors/{authorId}/tags
Sample Request
DELETE /v3/authors/12345/tags
Sample Response
A call that could not remove all tags from an author returns a 400 code.
A call referencing an invalid author ID will return a 404 code. Ensure you referenced the correct author value.
Create Comment for Author

This method creates a comment for the specified author.
/v3/authors/{id}/comments
HTTP Method
POST
Request Parameters

POST /v3/authors/{id}/comments
Sample Request
POST /v3/authors/{id}/comments
{
19
Authors Retrieve Comment for Author
"value": "i heart talk radio"

}
Sample Response
A successful call returns a 201 code with the applicable Location header.
A call including an invalid JSON object returns a 400 code.
A call including an invalid author returns a 404 code.
A call encountering an internal server error while adding the comment returns a 500 code.
Retrieve Comment for Author

This method returns all comments for a specified author.
/v3/authors/{id}/comments
HTTP Method
GET
Request Parameters

*limit* - integer value indicating number of results to return (defaults to 25). This
method does not return any deleted comments.
*offset* - integer value indicating result to start with (defaults to 0)

GET /v3/authors/{id}/comments
Sample Request
GET /v3/authors/{id}/comments
Sample Request
{
"data" : [
{
"id": "2751",
"authorId": 53,
20
Authors Delete Author Comment
"value": "i heart talk radio",

"deleted": null,
"created": {
"userId": 26341,
"clientId": 11084,
"name": "APIQECLIENT1USER1",
"date": "2015-07-27T13:53:48Z"
}
}
],
"meta" : {
"totalCount" : 1
}
}
*data* - array of information on comment

*id* - string value identifying comment
*authorId* - string value identifying author of comment
*value* - string value containing text of comment
*deleted* - string value indicating a deleted comment
*created* - array of information about comment creation
*userId* - string value of user ID for comment within system
*clientId* - string value of client ID for comment within system
*name* - string value of comment within system
*date* - timestamp value of creation within system
Sample Response
A call referencing a nonexistent author returns a 404 error.
A call that encounters an internal error while retrieving the author returns a 500 error.
Delete Author Comment

This method deletes a comment from the specified author.
/v3/authors/{id}/comments/{commentId}
HTTP Method
DELETE
Request Parameters

*commentId* - string value indicating the comment to delete (required)
21
Authors Delete Author Comment

DELETE /v3/authors/{id}/comments/{commentId}
Sample Request
DELETE /v3/authors/{id}/comments/{commentId}
Sample Response
A successful call returns a 204 No Content code.
A call including an invalid author, a previously deleted note, or a nonexistent note returns a 404 code.
A call encountering an internal server error while deleting the comment returns a 500 code.
22
CHAPTER 4 Clients
In this chapter ... Use the Clients endpoint to retrieve basic information about the Social Studio organization (such as org
name, ID, timezone, and language).
Retrieve Clients
Retrieve Client Information

Retrieve client information using the following call:
GET /v3/clients
cURL Example
curl -X GET -H "access_token: 82200099-7799-4023-b76d-11bb7c941bf1"
'https://api.socialstudio.radian6.com/v3/clients'
23
Clients Retrieve Clients
Retrieve Clients
This method retrieves the Social Studio organization for your company. At this time, this call returns only the client for the authenticated
user.
/v3/clients
HTTP method
GET
Request Parameters
None

GET /v3/clients
Sample Request
GET /v3/clients
Sample Response
{
"data": [
{
"id": "1",
"title": "Radian6 Technologies",
"email": null,
"timeZone": "America/Halifax",
"languageId": 1,
"sessionTimeoutMillis": 28800000,
"aviaryEnabled": false,
"apiSelfServeEnabled": true
}
],
"meta": {
"totalCount": 1
}
}
*id* - integer value identifying organization

*title* - string value for name of organization
*email* - string value for email address associated with organization
24
Clients Retrieve Clients
*timeZone* - string value for time zone associated with organization

*languageId* - integer value indicating language associated with organization
*sessionTimeoutMillis* - integer value indication number of milliseconds associated with
timeout value for organization
*aviaryEnabled* - boolean value indicating whether organization can use aviary
*apiSelfServeEnabled* - boolean value indicating organization access to API self-service
features
*bitlyEnabled* - boolean value indicating whether Bitly is enabled
25
CHAPTER 5 Users
In this chapter ... Use the Users endpoint to manage basic aspects of Social Studio user accounts.
Retrieve Users
Retrieve User Retrieve a User
Create User
Update User GET /v3/users/{id}
Reset Password
Modify Password
cURL Example
curl -X GET -H "access_token: 513e6576-218d-4a9e-b7cc-ac4ebf45fd1e"
'https://api.socialstudio.radian6.com/v3/users/me'
Create a User
POST /v3/users
cURL Example
curl -X POST -H "access_token: 513e6576-218d-4a9e-b7cc-ac4ebf45fd1e"
-H "Content-Type: application/json" -d ' {
"title": "API User",
"username": "APIUser",
"displayName": "API User",
"email": "email@salesforce.com",
"timeZone": "Europe/London",
"enabled": true,
"avatarURL": null,
"userRoleId": 6,
"orgRoleId": 1,
"languageId": 1,
"clientId": 1
}' 'https://api.socialstudio.radian6.com/v3/users'
26
Users Retrieve Users
Retrieve Users
This method retrieves information for all users within an account
/v3/users
HTTP Method
GET
Request Parameters
None
Query Parameters
*q* - string value including characters to search for in title (minimum of 3 characters)
*enabled* - boolean value indicating whether to retrieve only active users
*true* - string value indicating return only active users
*false* - string value indicating return all users
*limit* - integer value indicating number of results to return (defaults to 100,000)
Sample Request
GET /v3/users
Sample Response
{
"data": [
{
"id": "3339",
"title": "Admin",
"username": "admin",
"displayName": "Admin",
"email": "testuser@example.com",
"timeZone": "America/Goose_Bay",
"enabled": true,
"orgRoleId": 1,
"languageId": 1,
"createdDate": "2014-05-09T03:00:00Z",
"clientId": 1
},

27
Users Retrieve User
],
"meta": {
"totalCount" : 52
}
}
*id* - integer value indicating unique ID for user

*title* - string value including name fo users
*username* - string value including network username for user
*email* - string value including email address for user
*timeZone* - string value indicating location for user
*enabled* - boolean value indicating user status
*true* - string value indicating enabled
*false* - string value indicating disabled user
*orgRoleId* - integer value indicating role for user within organization
*languageId* - integer value indicating language used by user
*createdDate* - timestamp value indicating when system created user
*internalUserAvatarUrl* - string value indicating location of avatar image file for internal
use
*userAvatarUrl* - string value indicating location of avatar image file
*clientId* - integer value indicating client ID for specific user
Retrieve User
This method retrieves information for a specified user within an account
/v3/users/{id}
HTTP Method
GET
Request Parameters
*id* - integer value indicating unique ID for user (you may also use the *me* shorthand
in place of this value)
Sample Request
GET /v3/users/{id}
Sample Response
{
"data": [
{
28
Users Create User
"id": "3339",
"title": "Admin",
"username": "admin",
"displayName": "Admin",
"email": "testuser@example.com",
"timeZone": "America/Goose_Bay",
"enabled": true,
"orgRoleId": 1,
"languageId": 1,
"createdDate": "2014-05-09T03:00:00Z",
"clientId": 1
},

],
"meta": {
"totalCount" : 1
}
}
*id* - integer value indicating unique ID for user

*title* - string value including name fo users
*username* - string value including network username for user
*email* - string value including email address for user
*timeZone* - string value indicating location for user
*enabled* - boolean value indicating user status
*true* - string value indicating enabled
*false* - string value indicating disabled user
*orgRoleId* - integer value indicating role for user within organization
*createdDate* - timestamp value indicating when system created user
use
*clientId* - integer value indicating client ID for specific user
Create User
This method creates a new user within a Social Studio tenant.
/v3/users
HTTP Method
POST
Request Parameters
None
29
Users Create User
JSON Parameters
*username* - string value including network username for user (required)

*displayName* - string value displaying user name (required)
*email* - string value indicating email address for user (required)
*timeZone* - string value indicating location for user (required)
*enabled* - boolean value indicating user status (required)
*true* - string value indicating enabled (required)
*false* - string value indicating disabled user (required)
*orgRoleId* - integer value indicating role for user within organization (required)
*1* - org_super_user
*2* - org_full_user
*3* - org_basic_user
*7* - org_admin_only
use

POST /v3/users
Sample Request
POST /v3/users
{
"username": "Matt.Jones@example.com",
"displayName": "Matt Jones",
"email": "Matt.Jones@example.com",
"enabled": true,
"avatarURL":
"http://a0.twimg.com/profile_images/1284202467/laptop-vector-model-122171296611479Nq0_normal.png",
"languageId": 1,
"internalUserAvatarUrl":
"http://socialstudio.s3.amazonaws.com/avatars/ad816b59936d93dc3ec36a43e15cbb8c"
}
Sample Response
A successful call returns a 201 code, indicating a successful creation.
A internal server error occuring during the call returns a 500 code. Try your call again later.
30
Users Update User
Update User
This method retrieves information for a specified user within a Social Studio tenant.
/v3/users/{id}
HTTP Method
PUT
Request Parameters
*id* - integer value indicating unique ID for user (you may also use the *me* shorthand
in place of this value)
JSON Parameters
*username* - string value including network username for user (required)

*displayName* - string value displaying user name (required)
*email* - string value indicating email address for user (required)
*timeZone* - string value indicating location for user (required)
*enabled* - boolean value indicating user status (required)
*true* - string value indicating enabled (required)
*false* - string value indicating disabled user (required)
*orgRoleId* - integer value indicating role for user within organization (required)
*1* - org_super_user
*2* - org_full_user
*3* - org_basic_user
*7* - org_admin_only
use

PUT /v3/users/{id}
Sample Request
PUT /v3/users/{id}
{
"username": "Matt.Jones@example.com",
"displayName": "Matt Jones",
"email": "Matt.Jones@example.com",
31
Users Reset Password
"enabled": true,
"avatarURL":
"http://a0.twimg.com/profile_images/1284202467/laptop-vector-model-122171296611479Nq0_normal.png",
"languageId": 1,
"internalUserAvatarUrl":
"http://socialstudio.s3.amazonaws.com/avatars/ad816b59936d93dc3ec36a43e15cbb8c"
}
Sample Response
A successful call returns a 204 No Content code, indicating a successful update.
A call referencing an invalid ID returns a 404 Not Found code. Ensure your call uses the correct ID.
A internal server error occuring during the call returns a 500 code. Try your call again later.
Reset Password
This method resets the password for an internal user account. A successful call also sends an email message (from support@radian6.com)
containing a link the user can click to set a new password value. This call requires administrative privileges.
/v3/users/{userId}/password?action=reset
HTTP Method
POST
Request Parameters
*userId* - integer value indicating unique ID for user (also accepts me shorthard)

POST /v3/users/{id}/password?action=reset
Sample Request
POST /v3/users/12345/password?action=reset
Sample Response
A successful call returns a 204 No Content code, indicating a successful update.
A call referencing an invalid ID returns a 404 Not Found code. Ensure your call uses the correct ID.
A internal server error occurring during the call returns a 500 code. Try your call again later.
32
Users Modify Password
Modify Password
This method triggers a password reset operation for a user
/users/{id}/password
HTTP Method
POST
Request Parameters
None
Sample Request
POST /users/1/password?action=change
33
CHAPTER 6 Workspaces
In this chapter ... Workspaces collect resources to support multiple social teams across a brand or regions. Workspaces
also support collaboration with agencies while controlling application access. This section helps you
Retrieve Workspaces create a workspace and add resources.
Retrieve Workspace
Create Workspace
Update Workspace
Get Workspaces
Delete Workspace
Before you create a new workspace, perform a retrieve on your existing workspaces to ensure one does
Create Workspace not already exist that would fit your needs:
Resources
GET /v1/workspaces
Delete Workspace
Resources
cURL Example
curl -X GET -H "access_token: ce5c9c9f-470b-4efc-8254-db8649ed77bd"
-H "Content-Type: application/json"
'https://api.socialstudio.radian6.com/v1/workspaces'
Create Workspaces
Add a new workspace using the following call:
POST /v1/workspaces
cURL Examples
curl -X POST -H "access_token: ce5c9c9f-470b-4efc-8254-db8649ed77bd"
"name": "Workspace Name",
"description": "This workspace is for Campaign X",
"logo": "/Pictures/workspace logo.png"
}' 'https://api.socialstudio.radian6.com/v1/workspaces'
34
Workspaces
Add a User to the Workspace

Add a user with the following call:
POST /v1/workspaceresources
cURL Examples
curl -X POST -H "access_token: your_access_token" -H "Content-Type:
application/json" -d '{
"workspace_id": "b8e4c9c4-9e3c-411f-ae80-7c2b3d6e2ab0",
"resource_type": "user",
"resource_id": "79799125",
"access": "contributor"
}' 'https://api.socialstudio.radian6.com/v1/workspaces'
35
Workspaces Retrieve Workspaces
Retrieve Workspaces
This method retrieves a paginated list of workspaces within the Social Studio organization.
/v1/workspaces
HTTP Method
GET
Request Parameters
*page* - integer value indicating which page to display from retrieved data (default of
1)
*perpage* - integer value indicating how many results to include in a page (value must
be greater than 1 and not exceed 25, default of 10)
*search* - string value indicating which characters to search for at start of workspace
name (only at beginning, not within name strings)
*orderBy* - string value indicating order of returned results:
*name* - name of workspace (default)
*updated* - last modified timestamp
*order* - string value indicating display direction for retrieved content:
*desc* - descending order
*asc* - ascending order (default)
*user* - string value identifying workspace user. This parameter defaults to *default*
value. The call ignores other values and returns an error for non-admin users.
*isMember* - boolean value that pairs with *user* parameter to return on workspaces with
an assigned role for the user.
*visibility* - string value indicating whether a workspace appears to all users:
*private* - does not appear (default)
*public* - does appear
*include* - comma-separated string values of additional information to include:
*permissions* - string value containing user permissions for the workspace
*defaultPublishProfile* - string value of default publish profile for workspace
*view* - can view social assets and posts
*edit_content* - same as *view* and can create content (such as posts)
*admin* - same as *edit_content* and can perform admin actions on workspace
*delete* - can delete workspace
*membercount* - string value containing total number of users for workspace
*socialassetcount* - string value containing total number of social assets for workspace
*engage* - string value containing user engage permissions

GET /v1/workspaces
36
Workspaces Retrieve Workspaces
Sample Request
The call below retrieves the workplaces within an account:
GET /v1/workspaces?visibility=public&search=salesforce&include=permissions,membercount
Sample Response
{
"status": true,
"response": [
{
"name": "workspace A",
"id": "46e66860-25fe-11e3-b1a1-168170973bd5",
"visibility": "public",
"logo": "a_logo.png",
"description": "A great workspace",
"group_id": "123"
},
{
"name": "Workspace B",
"id": "46f96860-25fe-11e3-b1a1-168170973bd5",
"logo": "b_logo.png",
"description": "B successful workspace",
"group_id": "234"
}
],
"meta": {
"total": 400,
"page": 2
"perpage": 2,
"current": "{HOST}/v1/workspaces?page=2&perpage=2&visibility=public",
"prev": "{HOST}/v1/workspaces?page=1&perpage=2&visibility=public",
"next": "{HOST}/v1/workspaces?page=3&perpage=2&visibility=public"
}
}
Error Responses
A call finding no workspaces returns the following response:
{
"status": true,
"response": [],
"meta": {
"total": 0,
"page": 1,
"perpage": 10,
37
Workspaces Retrieve Workspace
"current": "{HOST}/v1/workspaces?page=1&perpage=10&visibility=public",
"prev": "",
"next": ""
}
}
A call including a bad argument returns the following response:
{
"status": false,
"response": {
"errors": [
{
"code": "error.bad_request",
"message": ""
}
]
},
"meta": []
}
*status* - string value indicating success of call

*response* - array of information indicating retrieval of workspaces
*name* - string value including name of workspace
*id* - string value of retrieved workspace
*visibility* - string value indicating public or private workspace
*logo* - string value including URL of logo image file
*description* - string value including description of workspace
*group_id* - reserved for internal use
Retrieve Workspace
This method retrieves a single workspace within the Social Studio organization.
/v1/workspaces/{id}
HTTP Method
GET
Request Parameters
*id* - string value identifying the workspace to retrieve

GET /v1/workspaces/{id}
38
Query Parameters
*include* - comma-separated string values of additional information to include:

*permissions* - string value containing user permissions for the workspace
*defaultPublishProfile* - string value of default publish profile for workspace
*view* - can view social assets and posts
*edit_content* - same as *view* and can create content (such as posts)
*admin* - same as *edit_content* and can perform admin actions on workspace
*delete* - can delete workspace
*membercount* - integer value including number of workspace members
*socialassetcount* - integer value including number of workspace members
*engage* - string value containing user engage permissions
Sample Request
The call below retrieves the specified workplace:
GET /v1/workspaces/46e66860-25fe-11e3-b1a1-168170973bd5?include=permissions,membercount
Sample Response
{
"status": true,
"response": {
"name": "A new workspace for the system",
"id": "46e66860-25fe-11e3-b1a1-168170973bd5",
"visibility": "private",
"logo": "workspace_logo.png",
"description": "A brand new workspace!",
"group_id": "123"
},
"meta": []
}
A call returning information on a private workspace the user cannot access returns the following response:
{
"status": true,
"response": {
"name": "PRIVATE WORKSPACE",
"id": "46e66860-25fe-11e3-b1a1-168170973bd5",
"visibility": "private"
},
"meta": []
}
A call including additional information returns the following response:

{
"status": true,
"response": {
39
"id": "46e66860-25fe-11e3-b1a1-168170973bd5",
"logo": "",
"description": "",
"group_id": "123",
"permissions": [
"view",
"edit_content",
"admin",
"delete"
],
"membercount": 100,
"socialassetcount": 50,
"engage": [
"view",
"edit"
]
},
"meta": []
}
Error Responses
A call referencing an invalid workspace returns the following response:
{
"status": false,
"response": {
"errors": [
{
"code": "error.not_found",
"message": ""
}
]
},
"meta": []
}
A call including an invalid ID returns the following response:

{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
40
"meta": []
}
{
"status": true,
"response": {
"id": "46e66860-25fe-11e3-b1a1-168170973bd5",
"logo": "",
"description": "",
"group_id": "123",
"permissions": [
"view",
"edit_content",
"admin",
"delete"
],
"membercount": 100,
"socialassetcount": 50,
"engage": [
"view",
"edit"
]
},
"meta": []
}

*response* - array of information regarding retrieval of workspace
*id* - string value of retrieved workspace
*visibility* - string value indicating public or private workspace
*name* - string value including name of workspace
*logo* - string value including URL of logo image file
*description* - string value including description of workspace
*group_id* - string value including ID of associated group
*permissions* - array of string values indicating permissions associated with workspace
*view*
*edit_content*
*admin*
*delete*
*membercount* - integer value including number of worksapce members
*socialassetcount* - integer value including number of worksapce members
*engage* - array of actions associated with engage functions in workspace
*view*
*"edit*
41
Workspaces Create Workspace
Create Workspace
This method creates a workspace within a Social Studio organization.
/v1/workspaces
HTTP Method
POST
Request Parameters
*name* - string value containing name of new workspace (required). This value includes a
maximum of 255 characters. The call removes leading and trailing whitespaces. The call
replaces multiple consecutive whitespaces with a single whitespace.
*description* - string value containing text describing the new workspace (defaults to
empty string)
*logo* - string value indicating the location of a workspace image file (defaults to empty
string)

POST /v1/workspaces
Sample Request
The call below creates a new piece of shared content with the specified message:
POST -d "name=A new workspace for the system" -d "visibility=private" -d
"logo=workspace_logo.png" -d "description=A brand new workspace." {HOST}/v1/workspaces
Sample Response
{
"status": true,
"response": {
"id": "95b75fac-0453-11e3-8d6f-168170973bd5"
},
"meta": []
}
42
Workspaces Update Workspace
Error Responses
An unsuccessful call due to a duplicate name returns the following response:
{
"status": false,
"response": {
"errors": [
{
"code": "error.conflict",
"message": ""
}
]
},
"meta": []
}
An unsuccessful call due to a bad parameter returns the following response:

{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}

*response* - string value indicating creation of workspace
*id* - string value indicating ID of newly created workspace
Update Workspace
This method updates a workspace within a Social Studio organization.
/v1/workspaces
HTTP Method
PATCH
Request Parameters
*id* - string value containing the ID value for the workspace (required)
43
Workspaces Update Workspace

PATCH /v1/workspaces/{id}
Query Parameters
*name* - string value containing name of new workspace. This value includes a maximum of
255 characters. The call removes leading and trailing whitespaces. The call replaces
multiple consecutive whitespaces with a single whitespace.
*description* - string value containing text describing the new workspace (defaults to
empty string)
*logo* - string value indicating the location of a workspace image file (defaults to empty
string)
Sample Request
PATCH -d "visibility=private" {HOST}/v1/workspaces/46e66860-25fe-11e3-b1a1-168170973bd5
Sample Response
{
"status": true,
"response": true,
"meta": []
}
Error Responses
An call referencing a nonexistent workspace returns the following response:
{
"status": false,
"response": {
"errors": [
{
"code": "error.not.found",
"message": ""
}
]
},
"meta": []
}
44
Workspaces Delete Workspace
An unsuccessful call due to insufficient permissions returns the following response:

{
"status": false,
"response": {
"errors": [
{
"code": "error.forbidden",
"message": ""
}
]
},
"meta": []
}

*response* - string value indicating updating of workspace
Delete Workspace
This method deletes a workspace within the Social Studio organization. This process results in the loss of any scheduled posts.
/v1/workspaces/{id}
HTTP Method
DELETE
Request Parameters
*id* - string value containing the ID value for the workspace

DELETE /v1/workspaces/{id}
Sample Request
The call below deletes the workspace and all associated content.
DELETE {HOST}/v1/workspaces/46e66860-25fe-11e3-b1a1-168170973bd5
45
Workspaces Delete Workspace
Sample Response
{
"status": true,
"response": true,
"meta": []
}
Error Responses
An call referencing a nonexistent workspace returns the following response:
{
"status": false,
"response": {
"errors": [
{
"code": "error.not.found",
"message": ""
}
]
},
"meta": []
}
An unsuccessful call due to a bad parameter returns the following response:

{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}
An unsuccessful call due to insufficient permissions returns the following response:

{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
46
Workspaces Create Workspace Resources
"meta": []
}

*response* - string value indicating deletion of workspace
Create Workspace Resources

This method adds an existing resource to a workspace
/v1/workspaceresources
HTTP Method
POST
Request Parameters
None

JSON Parameters
Each JSON payload includes the resource type:
*workspace_id* - string value identifying owner of workspace resources (required)

*resource_type* - string value indicating type of workspace resource created by the call:
*topic_profile*
*engage_macro*
*template*
*social_property*
*user*
*publish_macro*
*resource_id* - string value containing identifier for the workspace resource
Sample Request
{
47
Workspaces Delete Workspace Resources
"workspace_id": "44dfccf0-ed00-4988-a256-0913281dcb89",
"resource_type": "topic_profile",
"resource_id": "19212"
}
Sample Response
{
"status": true,
"response": {
"resource_id": "19212",
"workspace_group_id": "8152"
},
"meta": []
}

*response* - string value indicating creation of workspace resource
*resource_type* - string value indicating type of workspace resource created by the
call
*workspace_group_id* - reserved for internal use
Delete Workspace Resources

This method removes a resource from a workspace. This process does not delete the resource from the Social Studio organization.
/v1/workspaceresources
HTTP Method
DELETE
Request Parameters
None

DELETE /v1/workspaceresources
48
Workspaces Delete Workspace Resources
JSON Parameters
Each JSON payload includes information on the shared content:
*workspace_id* - string value identifying owner of workspace resources (required).

*resource_type* - string value indicating type of workspace resource created by the call.
*resource_id* - string value containing identifier for the workspace resource.
Sample Request
DELETE /v1/workspaceresources
{
"workspace_id": "44dfccf0-ed00-4988-a256-0913281dcb89",
"resource_id": "19212"
}
Sample Response
{
"status": true,
"response": {
"resource_id": "19212",
"workspace_group_id": "8152"
},
"meta": []
}

*response* - string value indicating deletion of workspace resource
*resource_type* - string value indicating type of workspace resource created by the
call
*workspace_group_id* - reserved for internal use
49
CHAPTER 7 Imported Posts
In this chapter ... Use this endpoint to retrieve all brand posts and associated metrics. These posts could include any posts
created within Social Studio or imported to Social Studio after posting on the social network itself. Make
Retrieve Posts & sure to include the specific metric parameters you want returned for the posts.
Metrics
Retrieve the Number of Comments on Posts

Retrieve the number of comments on a post using the following call:
POST /v1/importedposts
cURL Example
application/json"
'https://api.socialstudio.radian6.com/v1/importedposts?startDate=1136500800&endDate=1437105599&metrics=comments'
50
Imported Posts Retrieve Posts & Metrics
Retrieve Posts & Metrics

This method retrieves posts and their metrics imported to a workspace.
/v1/importedposts
HTTP Method
GET
Request Parameters
None
Query Parameters
*workspace* - integer value indicating the workgroup

*startDate* - date value indicating the start date from which to retrieve posts (required)
*endDate* - date value indicating the end date from which to retrieve posts (required)
*network* - string value indicating social network for post:
*all* (default)
*facebook*
*twitter*
*linkedin*
*gplus*
*youtube*
*instagram*
*socialProperty* - string values (in a comma-delimited list) indicating the social properties
from which to retrieve the post (defaults to all social properties included in workspace)
*socialAsset* - string value indicating the Social Account Set ID from a workspace (defaults
to all social accounts included in workspace)
*metrics* - string values (in a comma-delimited list) included in the response:
*facebook*
*likes*
*comments*
*shares*
*reach*
*organic_reach*
*viral_reach*
*paid_reach*
*fan_reach*
*non_fan_reach*
*fan_paid_reach*
*engagement*
*clicks*
*engagement_rate*
*twitter*
*retweets*
*replies*
51
*favorites*
*link_clicks*
*engagement*
*engagement_rate*
*linkedin*
*likes*
*comments*
*link_clicks*
*engagement*
*gplus*
*plusone*
*reshares*
*comments*
*link_clicks*
*engagement*
*youtube*
*views*
*likes*
*dislikes*
*comments*
*link_clicks*
*engagement*
*instagram*
*likes*
*comments*
*pinterest*
*likes*
*comments*
*repins*
*link_clicks*
*labels* - string value (in a comma-delimited list) indicating labels to use in filter
*type* - string value indicating media type to use in filter
*orderBy* - string value indicating parameter used to sort results (defaults to date)
*order* - string value indicating display direction for retrieved content (defaults to
DESC):
*DESC* - descending order (default)
*ASC* - ascending order
*page* - integer value indicating which page to display from retreived data (defaults to
1)
*perpage* - integer value indicating how many results to include in a page (defaults to
10)
*filter* - string value indicating publish status of post (defaults to unpublished)

GET /v1/importedposts
Sample Request
The call below retrieves all imported posts from a specified workspace:
GET /v1/importedposts?workspace=1
52
The call below retrieves all imported Facebook posts from a specified workspace:
GET /v1/importedposts?workspace=1&network=facebook
The call below retrieves all imported Facebook posts from a specified workspace with specified metrics:
GET /v1/importedposts?workspace=1&network=facebook&metrics=likes,comments
The call below retrieves all imported Facebook posts from a specified workspace with specified metrics:
GET /v1/importedposts?workspace=1&network=facebook&metrics=likes,comments&orderBy=comments
Sample Response
Each imported post includes the following properties:
*id* - string value indicating ID of imported content

*socialAsset* - string value indicating ID of social asset
*socialProperty* - string value indicating ID of social property
*slug* - string value of slug for imported content
*assets* - array of information on assets within imported content
*id* - numeric value including ID for imported asset
*created* - timestamp value indicating asset creation data
*metadata* - string value including metadata associated with imported asset
*post_id* - string value including ID for post associated with asset
*type* - integer value indicating type of asset
*1* - Album
*2* - Image
*3* - Link
*4* - Question
*5* - Video
*updated* - timestamp value indicating asset updating data
*url* - string value including URL for asset
*date* - timestamp value indicating date for content creation
*message* - string value including message of content
*network* - string value including social network used for content
*targeting* - string value indicating targeting for content
*labels* - string value indicating labels for content
*type* - string value indicating type of content within social network (such as update)
*socialAssetName* - string value including name of content from social network
*blogPostId* - string value indicating ID of associated blog post
*metrics* - array of information about social content analytics
*likes* - integer value of social network likes
*comments* - integer value of social network comments
A successful call returns posts from all networks in last seven days in descending order:
{
"status": true,
"response": [
{
"id": "35db3b27-edd5-4d35-8ef7-574b0f483524",
"socialAsset": "200012913364042",
"socialProperty": 8307,
"slug": "/Buddy-The-Dog/200012913364042",
53
"assets": {
"id": 46,
"created": "2013-08-12T10:48:28-0400",
"metadata": "{\"link_type\":\"link\",\"title\":\"CRM and Cloud Computing
To Grow Your Business -
Salesforce.com\",\"caption\":\"http://Salesforce.com\",\"description\":\"You can change
stuff
here\",\"images\":[\"http://www.sfdcstatic.com/common/assets/img/logo-company.png\"],\"image_index\":0,\"thumbnail\":true,\"share_link\":false,\"url\":\"http://Salesforce.com\",\"video_src\":null,\"type\":\"link\"}",
"post_id": "35db3b27-edd5-4d35-8ef7-574b0f483524",
"type": 3,
"updated": "2013-08-12T10:48:28-0400",
"url": "http://Salesforce.com"
},
"date": "2013-08-13 09:45:03",
"message": "Salesforce.com is cool!",
"network": "facebook",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"socialAssetName": "Buddy - The Dog",
"blogPostId": 1234
},
{
"id": "b93ab12e-37cd-4344-bffa-3a59f5053580",
"socialAsset": "200012913364042",
"assets": [ ],
"date": "2013-08-12 15:29:40",
"message": "yahoo.com",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234
},
{
"id": "9bc25322-49ca-4b9c-ae81-20ff1b593edf",
"socialAsset": "200012913364042",
"assets": {
"id": 47,
"created": "2013-08-12T10:48:29-0400",
stuff
"post_id": "9bc25322-49ca-4b9c-ae81-20ff1b593edf",
"type": 3,
54
"updated": "2013-08-12T10:48:29-0400",
},
"date": "2013-08-12 09:45:03",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234
}
...
],
"meta": {
"total": 6,
"perpage": 10,
"current": 1,
"prev": "",
"next": ""
}
}
A successful call returns posts from Facebook in last seven days in descending order:
{
"status": true,
"response": [
{
"id": "35db3b27-edd5-4d35-8ef7-574b0f483524",
"socialAsset": "200012913364042",
"assets": {
"id": 46,
"created": "2013-08-12T10:48:28-0400",
stuff
"type": 3,
"updated": "2013-08-12T10:48:28-0400",
},
"date": "2013-08-13 09:45:03",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234
55
},
{
"socialAsset": "200012913364042",
"assets": {
"id": 47,
"created": "2013-08-12 10:48:29",
stuff
"type": 3,
"updated": "2013-08-12T10:48:29-0400",
},
"date": "2013-08-12 09:45:03",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234
}
...
],
"meta": {
"total": 16,
"perpage": 10,
"current": 1,
"prev": "",
"next": ""
}
}
A successful call returns posts from Facebook in last seven days in descending order with metrics:
{
"status": true,
"response": [
{
"id": "35db3b27-edd5-4d35-8ef7-574b0f483524",
"socialAsset": "200012913364042",
"assets": {
"id": 46,
"created": "2013-08-12T10:48:28-0400",
56

stuff
"type": 3,
"updated": "2013-08-12T10:48:28-0400",
},
"date": "2013-08-13 09:45:03",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234,
"metrics": {
"likes": 300,
"comments": 400
}
},
{
"socialAsset": "200012913364042",
"assets": {
"id": 47,
"created": "2013-08-12T10:48:29-0400",
stuff
"type": 3,
"updated": "2013-08-12T10:48:29-0400",
},
"date": "2013-08-12 09:45:03",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234,
"metrics": {
"likes": 100,
"comments": 800
}
}
57
...
],
"meta": {
"total": 16,
"perpage": 10,
"current": 1,
"prev": "",
"next": ""
}
}
A successful call returns posts from Facebook in last seven days sorted by comments in descending order with metrics:
{
"status": true,
"response": [
{
"id": "35db3b27-edd5-4d35-8ef7-574b0f483524",
"socialAsset": "200012913364042",
"assets": {
"id": 46,
"created": "2013-08-12T10:48:28-0400",
stuff
"type": 3,
"updated": "2013-08-12T10:48:28-0400",
},
"date": "2013-08-13 09:45:03",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234,
"metrics": {
"likes": 300,
"comments": 800
},
"blogPostId": 1234
},
{
"socialAsset": "200012913364042",
"assets": {
58
"id": 47,
"created": "2013-08-12T10:48:29-0400",
stuff
"type": 3,
"updated": "2013-08-12T10:48:29-0400",
},
"date": "2013-08-12 09:45:03",
"targeting": [ ],
"labels" : [ ],
"type": "status",
"blogPostId": 1234,
"metrics": {
"likes": 100,
"comments": 600
}
}
...
],
"meta": {
"total": 16,
"perpage": 10,
"current": 1,
"prev": "",
"next": ""
}
}
59
CHAPTER 8 Shared Content
In this chapter ... Share content across teams using this functionality. Agencies can also share content after finishing the
planning phase for your content. Create the content from an existing post, then share it to other
Retrieve Shared workspaces or send it to another tool (such as a content management system).
Content
Share & Unshare
Content Create Shared Content
Create Shared
Content Ensure you host the image before sharing it:
Archive & Unarchive POST /v1/clips
Shared Content
Delete Shared
Content cURL Example
curl -X POST -H "access_token: a133c435-dd3a-4727-8c07-08e09f0b1a97"
"message":"Message text",
"description":"Optional description about why I am sharing this
content to others",
"assets": [{"url":"http://www.foo.com/images/foo.png", "type":2,
"metadata":""}],
"workspaces": ["88c282e3-b33e-4109-bb86-9040c368bf75"],
"workspace_id": "b8e4c9c4-9e3c-411f-ae80-7c2b3d6e2ab0"
}' 'https://api.socialstudio.radian6.com/v1/clips'
Create Shared Content and Associate It to an Existing

Post
Ensure you host the image before sharing it:
POST /v1/clips
cURL Example
curl -X POST -H "access_token: 67fbd2fa-c885-4c53-a383-9d4d18e1763b"
-H "Content-Type: application/json" -H -d '{
"post_id": "65fe0314-9737-4fd3-acd5-a7c1cf636b7a",
"message": "This duplicates that content from an existing post
60
Shared Content
into a new piece of shared content,and associates them together when

measuring performance of content.",
"description":"This image did very well on Pinterest, please try
it on your regional accounts.",
"assets": [{"url":"http://www.foo.com/images/foo.png", "type":2,
"metadata":""}],
"workspaces": ["88c282e3-b33e-4109-bb86-9040c368bf75"],
"workspace_id": "b8e4c9c4-9e3c-411f-ae80-7c2b3d6e2ab0"
}' 'https://api.socialstudio.radian6.com/v1/clips'
Delete Shared Content

This call removes content from all workspaces and removes access to any analytics for the content:
DELETE /v1/clips/{id}
cURL Example
curl -X DELETE -H "access_token: a133c435-dd3a-4727-8c07-08e09f0b1a97"
-H
'https://api.socialstudio.radian6.com/v1/clips/e15318fa-c194-45e1-99d3-05f39e103e0f'
Archive Shared Content

This call disables usage of shared content for a new post. However, users in workspaces to which you
shared th content can still view performance metrics for the content:
POST /v1/clips/{id}?action=archive
cURL Example
-H "Content-Type: application/json"
-d ''
'https://api.socialstudio.radian6.com/v1/clips/22a27159-832c-47f1-9313-5533dfe40a8d?action=archive'
Unshare Shared Content

To unshare content from one or more recipient workspaces, define an array of workspaces from which
to unshare. Ensure you provide only workspaces where it has been shared to previously:
POST /v1/clips/{id}?action=unshare
61
Shared Content
cURL Example
"workspaces": ["a0fd4ce7-af4c-48b1-b6e8-0cb4ce54b2fc",
"c2e918d2-4309-11e3-bb55-1cb63b08732c"]
}'
'https://api.socialstudio.radian6.com/v1/clips/22a27159-832c-47f1-9313-5533dfe40a8d?action=unshare'
62
Shared Content Retrieve Shared Content
Retrieve Shared Content

This method retrieves content available for use within a workspace.
/v1/clips/
HTTP Method
GET
Request Parameters
None
Query Parameters
*workspace* - string value indicating workspace from which to retrieve content (required)
*filter* - string value indicating which content to retrieve:
*all* - any content (default)
*owner* - any content owned by a specific owner
*shared* - any content shared for use
*include* - string value requesting additional information:
*metrics* - analytics information for specified content
*sort* - string value indicating order to display retrieved content:
*created* - sort by created date (default)
*avg_engagement* - sort by average number of engagement
*direction* - string value indicating display direction for retrieved content:
*desc* - descending order (default)
*asc* - ascending order
1)
*perpage* - integer value indicating how many results to include in a page (defaults to
10)

GET /v1/clips
Sample Request
The call below retrieves all clips from the specified workplace with analytics data:
GET /v1/clips?workspace=584d3ad3-2f7b-11e3-b8e3-168170973bd5&filter=all&include=metrics
The call below retrieves a clip by ID:

GET v1/clips/35543aba-18b2-4995-bb76-ea1132fe544a
63
Sample Response
A successful call requesting all clips with analytics data returns the following response:
{
"status": true,
"response": [
{
"id": "35543aba-18b2-4995-bb76-ea1132fe544a",
"source_type": "post",
"source_id": "93023aba-18b2-4995-bb76-ea1132fe544a",
"organization_id": "10567",
"archived": 0,
"deleted": 0,
"message": "Post message",
"description": "Clip comment",
"start_date": null,
"end_date": null,
"created": "2014-02-02 11:00:00",
"updated": "2014-02-03 11:00:00",
"assets": [
{
"url": "https://d2ee3wvl22m8i7.cloudfront.net/_blue.jpg",
"type": "2",
"metadata": null
}
],
"owner_workspace":
{
"id": "75443f9c-349b-4bfa-a124-b188d4a8719f",
"owner": "1",
"name": "Buddy - The Dog",
"logo": null
},
"shared_workspace_count": 0,
"shared_workspaces": [
{
"id": "adlskasdaf-dsafada",
"name": "workspace 1",
"logo": "http://image.jpg"
},
{
}
],
"post_count": 19,
"metrics": {
"engagement": 354,
"average_engagement": 177,
"engagement_rate": {
"facebook": 1.4,
"twitter": 1.5
}
64
}
},
{
...
},
...
]
"meta": {
"total": 5,
"perpage": 10,
"current": 1,
"prev": "",
"next": "/clips?page=2&perpage=10"
}
}
A successful call for a specific piece of content returns the following response:
{
"status": true,
"response": {
"id": "35543aba-18b2-4995-bb76-ea1132fe544a",
"source_type": "post",
"source_id": "93023aba-18b2-4995-bb76-ea1132fe544a",
"organization_id": "10567",
"archived": 0,
"deleted": 0,
"message": "Post message",
"description": "Clip comment",
"start_date": null,
"end_date": null,
"created": "2014-02-02 11:00:00",
"updated": "2014-02-03 11:00:00",
"assets": [
{
"url": "https://d2ee3wvl22m8i7.cloudfront.net/_blue.jpg",
"type": "2",
"metadata": null
}
],
"owner_workspace":
{
"id": "75443f9c-349b-4bfa-a124-b188d4a8719f",
"owner": "1",
"name": "Buddy - The Dog",
"logo": null
},
"shared_workspace_count": 0,
"shared_workspaces": [
{
},
{
65
}
],
"post_count": 19,
"metrics": {
"engagement": 354,
"average_engagement": 177,
"engagement_rate": {
"facebook": 1.4,
"twitter": 1.5
}
}
},
"meta": []
}

*response* - array of information related to retrieved content:
*id* - string value indicating ID of content
*source_type* - string value indicating method of creation for content
*source_id* - string value containing ID of content source
*organizationId* - sting value containing ID of organization
*archived* - integer value indicating number of archived posts
*deleted* - integer value indicating number of deleted posts
*message* - string value including content message
*description* - string value including description of content
*start_date* - timestamp value including start date for content
*end* - timestamp value including end date for content
*created* - timestamp value including creation date for content
*updated* - timestamp value including update date for content
*assets* - array value including information on content
*url* - string value including URL for content assets
*type* - integer value indicating the media type for the imported post:
*1* - MEDIA_TYPE_ALBUM
*2* - MEDIA_TYPE_LINK
*3* - MEDIA_TYPE_PHOTO
*4* - MEDIA_TYPE_STATUS
*5* - MEDIA_TYPE_VIDEO
*metadata* - addtional date for content
*owner_workspace* - array value including data on workspacing owning content
*id* - string value including ID for owner workspace
*owner* - integer value indicating owner
*name* - string value including name of content in workspace
*logo* - string value indicating logo assocaited with content
*shared_workspace_count* - integer value indicating number of workspaces sharing content
*shared_workspaces* - array including information on workspaces sharing content

*id* - string value indicating ID of workspace sharing content
*name* - string value including name of workspace sharing content
*logo* - string value including location of logo image file
*post_count* - integer value indicating number of times post used
66
Shared Content Share & Unshare Content
*metrics* - array of information on content

*engagement* - integer value including number of engagements
*average_engagement* - integer value including average number of engagement
*engagement_rate* - array of engagement information by social network
*facebook* - integer value including engagement rate on Facebook
*twitter* - integer value including engagement rate on Twitter
Share & Unshare Content

This method shares and unshares content with other workspaces.
/v1/clips/{id}
HTTP Method
POST
Request Parameters
*id* - ID for the clip (required)

*action* - string value indicating the action to perform on the content:
*share* - share content with other workspaces in the Social Studio organization
*unshare* - unshare content with other workspaces in the Social Studio organization

POST /v1/clips/{ID}?action=share
JSON Parameters
*workspaces* - array of string value indicating the workspaces with which to share the
content
Sample Request
The call below shares the specified content:
POST v1/clips/35543aba-18b2-4995-bb76-ea1132fe544a?action=share
67
Shared Content Create Shared Content
Sample Response
# HTTP 200 Success
{
"status": true,
"response": {},
"meta": {},
}
Create Shared Content

This method creates shared content and allows for distribution to other workspaces.
/v1/clips/
HTTP Method
POST
Request Parameters
None

POST /v1/clips
JSON Parameters
Each JSON payload includes information on the shared content:
*message* - string value indicating the message to share (required). The JSON payload must
include a *message* value or an *assets* value. You can include both.
*assets* - string value indicating URL and type of content (required). The JSON payload
must include a *message* value or an *assets* value. You can include both.
*url* - string value indicating URL for content
*type* - integer value indicating the media type for the imported content:
*1* - MEDIA_TYPE_ALBUM
*2* - MEDIA_TYPE_LINK
*3* - MEDIA_TYPE_PHOTO
*4* - MEDIA_TYPE_STATUS
*5* - MEDIA_TYPE_VIDEO
*workspaces* - string value identifying the workspace in which you can access the content
68
Shared Content Create Shared Content
(required).
*workspace_id* - string value identifying owner of shared content (required). You can leave
this value blank.
*description* - string value containing text describing the shared content.
*post_id* - string value containing the GUID for the existing post containing the shared
content to link and use for performance reporting
*clip_id* - string value containing a GUID for a clip containing the shared content to
link and use for performance reporting
Sample Request
{
"message": "This is a test message",
"workspaces": ["c2e918d2-4309-11e3-bb55-1cb63b08732d"],
"workspace_id": "584d3ad3-2f7b-11e3-b8e3-168170973bd5"
}
The call below creates a new piece of shared content with the specified asset:
{
"assets": [{"url":"http://www.foo.com", "type":2}}],
"workspaces": ["c2e918d2-4309-11e3-bb55-1cb63b08732d"],
"workspace_id": "584d3ad3-2f7b-11e3-b8e3-168170973bd5"
}
The call below creates a new piece of shared content and shares it to the specified workspaces:
{
"workspace_id": "584d3ad3-2f7b-11e3-b8e3-168170973bd5",
"description": "This is a test comment",
"assets": [{"url":"http://www.foo.com", "type":3,
"metadata":"{\"url\":\"http://www.foo.com\"}"}],
"workspaces": ["c2e918d2-4309-11e3-bb55-1cb63b08732d"]
}
The call below creates a new piece of shared content containing an image from an existing post:
{
"post_id": "82e6c061-2c5a-11e3-b1a1-168170973bd5"
"assets": [{"url":"http://www.foo.com/images/foo.png", "type":2}],
}
The call below duplicate a piece of shared content containing an link from an existing clip:
{
"clip_id": "82e6c061-2c5a-11e3-b1a1-168170973bd5"
69
Shared Content Archive & Unarchive Shared Content
"assets": [{"url":"http://www.foo.com", "type":3}],

}
Sample Response
# HTTP 201 Created
{
status: true,
response: {
id: "35543aba-18b2-4995-bb76-ea1132fe544a",
},
meta: {},
}

*id* - string value indicating ID for newly created content
Archive & Unarchive Shared Content

This method archives and unarchives content within a workspace.
/v1/clips/{id}
HTTP Method
POST
Request Parameters
*id* - ID for the clip (required)

*action* - string value indicating the action to perform on the content:
*archive* - archive the content, making it available for review but not for use
*unarchive* - unarchive the content and make it avaiable for use

POST /v1/clips/{ID}?action=archive
70
Shared Content Delete Shared Content
Sample Request
The call below archives the specified content:
POST v1/clips/35543aba-18b2-4995-bb76-ea1132fe544a?action=archive
Sample Response
# HTTP 200 Success
{
"status": true,
"response": {},
"meta": {},
}
Delete Shared Content

This method deletes content within the origin and recipient workspaces.
/v1/clips/{id}
HTTP Method
DELETE
Request Parameters
*ID* - ID for the clip (required)

DELETE /v1/clips/{id}
Sample Request
The call below deletes the specified content:
DELETE v1/clips/35543aba-18b2-4995-bb76-ea1132fe544a
71
Shared Content Delete Shared Content
Sample Response
# HTTP 200 Success
{
"status": true,
"response": {},
"meta": {},
}
72
CHAPTER 9 Short URLs
In this chapter ... Short URLs allow nrands to manage URL shortening services within the suite. Currently, Social Studio
supports shortening and tracking clicks on links using the Bitly URL shortening service. Add your own
Retrieve Short URLs Bitly accounts in order to shorten links using your own vanity URLs and track clicks both within Bitly as
Retrieve Short URL well as within Social Studio. Link tracking only applies to links published via Social Studio.
Create Short URL
Delete Short URL
Add a Bitly Account
Add a Bitly account to a workspace using the following call:
POST /v1/shorturls
cURL Example
curl -X POST -H access_token: 418adb62-b49f46f7-be1e-c4d82c4b0fef
https://api.socialstudio.radian6.com/v1/shorturls?workspace=b8e4c9c49e3c411f-ae807c2b3d6e2ab0&accessToken={{bitlyToken}}
73
Short URLs Retrieve Short URLs
Retrieve Short URLs

This method returns Bitly accounts within a workspace.
/v1/shorturls
HTTP Method
GET
Request Parameters
None
Query Parameters
*workspace* - string value indicating unique ID for workspace (required)

*page* - integer value indicating number of result pages to return as part of the call
(defaults to 1)
*perpage* - integer value indicating number of results to return per page (range from 1
to 25, defaults to 10)
*search* - string value indicating the first characters in the titles as part of the search
(returns only characters from the start of the title)

GET /v1/shorturls
Sample Request
curl GET
'{HOST}/v1/shorturls?workspace=028e2d63-0914-11e3-8d6f-168170973bd5&page=2&perpage=2'
Sample Response
A successful call returns the folowing response:
{
"status": true,
"response": [
{
"customShortDomain": "gofi.gs ",
"id": "5239534f-0b58-11e3-8d6f-168170973bd5",
"login": "dummy",
"token": "thisisatestaccesstoken1"
},
74
Short URLs Retrieve Short URLs
{
"customShortDomain": "gofi.gs ",
"id": "9e9318c5-0c00-11e3-8441-168170973bd5",
"login": "dummy",
}
],
"meta": {
"total": 4,
"page": 1,
"perpage": 2,
"current":
"{HOST}/v1/shorturls?perpage=2&workspace=028e2d63-0914-11e3-8d6f-168170973bd5&page=1",
"prev": "",
"next":
"{HOST}/v1/shorturls?perpage=2&workspace=028e2d63-0914-11e3-8d6f-168170973bd5&page=2"
}
}
*response* - array of objects containing information on

*customShortDomain* - string value indicating Bitly account domain
*id* - string value indicating unique ID for Bitly account within workspace
*login* - string value indicating Bitly account user
*token* - string value indicating OAuth user token
A call that returns no results based on the provided criteria includes the following response:
{
"status": true,
"response": [],
"meta": {
"total": 0,
"page": 1,
"perpage": 10,
"current":
"{HOST}/v1/shorturls?workspace=14a6e8f7-2c59-11e3-b1a1-168170973bd5&page=1",
"prev": "",
"next": ""
}
}
Modify your criteria as needed.

A call containing an invalid parameter returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": "{{is dependent upon the bad argument}}"
}
]
},
75
Short URLs Retrieve Short URL
"meta": []
}
Ensure you enter the correct parameters for your call.
Retrieve Short URL

This method returns a specific Bitly account within a workspace.
/v1/shorturls/{id}
HTTP Method
GET
Request Parameters
*id* - string value indicating unique ID for Bitly account

GET /v1/shorturls{id}
Sample Request
curl GET {HOST}/v1/shorturls/123
Sample Response
A successful call returns the folowing response:
{
"status": true,
"response": [
{
"customShortDomain": "www.cus.tom",
"id": "5239534f-0b58-11e3-8d6f-168170973bd5",
"login": "dummy",
}
],
}
*response* - array of objects containing information on Bitly account

*customShortDomain* - string value indicating Bitly account domain
76
Short URLs Create Short URL
*id* - string value indicating unique ID for Bitly account within workspace
*login* - string value indicating Bitly account user
*token* - string value indicating OAuth user token
{
"status": false,
"response": {
"errors": [
{
"message": "Could not find a shorturl with that id"
}
]
},
"meta": []
}
Ensure you use the correct ID value in your call.

{
"status": false,
"response": {
"errors": [
{
"message": "{{is dependent upon the bad argument}}"
}
]
},
"meta": []
}
Create Short URL

This method associates a Bitly account.
/v1/shorturls
HTTP Method
POST
Request Parameters
None
77
Short URLs Create Short URL
JSON Parameters
*id* - string value including the unique identifier for the workspace
*accessToken* - string value containing the OAuth access token generated for accessing the
bit.ly account

POST /v1/shorturls
Sample Request
curl -X POST -d "workspace=95b75fac-0453-11e3-8d6f-168170973bd5" -d
"accessToken=thisisatestaccesstoken" {HOST}/v1/shorturls
Sample Response
{
"status":true,
"response":{
"id":"5239534f-0b58-11e3-8d6f-168170973bd5"
},
"meta":[]
}
*id* - string value indicating unique ID for the URL shortener within the workspace
A call referencing an account already associated with a workspace returns the following response:
{
"status":false,
"response":{
"errors":[
{
"code":"error.conflict",
"message":"this login already exists in the workspace."
}
]
},
"meta":[]
}
Ensure that you create a new account for the workspace or use an update call.
{
"status":false,
78
Short URLs Delete Short URL
"response":{
"errors":[
{
"code":"error.bad_request",
"message":"Workspace not found"
}
]
},
"meta":[]
}
Delete Short URL

This method deletes all Bitly accounts associated with a workspace.
/v1/shorturls
HTTP Method
DELETE
Request Parameters
*id* - string value indicating unique ID for Bitly account

DELETE /v1/shorturls/{id}
Sample Request
curl -X DELETE {HOST}/v1/shorturls/740a25ea-0b57-11e3-8d6f-168170973bd5
Sample Response
{
"status":true,
"response":{
"id":"5239534f-0b58-11e3-8d6f-168170973bd5"
},
"meta":[]
}
79
Short URLs Delete Short URL
{
"status": false,
"response": {
"errors": [
{
"message": "Could not find a shorturl with that id"
}
]
},
"meta": []
}
Ensure you use the correct ID value in your call.

A call without the proper permissions returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": "You do not have access to delete"
}
]
},
"meta": []
}
80
CHAPTER 10 Publish Macros
In this chapter ... Publish Macros allow you to configure predefined metadata for several attributes for use (even
automatically applied) when creating a brand post within a workspace.
Retrieve Publish
Macros
Attributes refer to categories of metadata, such web analytics, publish labels, or social accounts.
Retrieve Publish
Macro Creating a Publish Macro
Retrieve Publish
Macro Attribute This example includes creating a new publish macro with attributes for web analytics tracking codes in
Create Publish Macro the Social Studio organization
Delete Publish Macro
POST /v3/publishprofiles
cURL Example
curl -X POST -H access_token: a78cabb9-c00e4f989127248003a7d9a1
-H Content-Type: application/json -d {
name: My Publish Profile 2.1,
webAnalytics: [
{
key : sample_key,
value : sample_value
},
{
key : sample_key2,
value : sample_value2
}
]
} https://api.socialstudio.radian6.com/v3/publishprofiles
After you create a publish macro, add it to a workspace to be used within the application. You can only
use publish macros within a single workspace. See /workspaceresources for more information on how
to add a publish macro to a workspace.
81
Publish Macros Retrieve Publish Macros
Retrieve Publish Macros

This method retrieves publish macros in the Social Studio organization
/v3/publishprofiles
HTTP Method
GET
Request Parameters
None
Query Parameters
*workspace* - string value indicating the unique ID for the workspace from which to retrieve
publish macros (required)
1)
*limit* - integer value indicating the number of results to display per page (defaults to
20)
*orderBy* - string value indicating parameter used to sort results (defaults to date)
*order* - string value indicating display order for retrieved content:
*desc* - descending order
*asc* - ascending order (default)
*search* - string value indicating charaters to search for in name, returns paginated
results from name matches

GET /v3/publishProfiles
Sample Call
curl
'{HOST}/v3/publishProfiles?workspace=028e2d63-0914-11e3-8d6f-168170973bd5&page=2&limit=2'
Sample Response
{
"publishProfiles": [
{
id: 000ca3cf-3ed1-4b7d-8253-0d50fe1e93fd,
82
Publish Macros Retrieve Publish Macros
"type": "publish",
"name": "My Publish Profile",
"description": "testing",
"owner": 6834,
"created": 'created_date',
"socialPropertyIds": '/v3/publishProfiles/:id/socialPropertyIds',
"youtubePlaylists": '/v3/publishProfiles/:id/youtubePlaylists',
"targetingIds": '/v3/publishProfiles/:id/targetingIds'
},
{
id: 000ca3cf-3ed1-4b7d-8253-0d50fe1e93fd,
"type": "publish",
"owner": 6834,
}
],
"count": 4,
"next": "{HOST}/v3/publishProfiles?limit=2&workspace=:workspaceId&page=2"
}
*id* - string value indicating unique identifier for publish profile

*type* - string value indicating type of profile
*publish*
*name* - string value indicating name of publish profile
*description* - string value indicating description of publish profile
*owner* - integer value indicating unique ID for publish profile owner
*created* - timestamp value indicating date of creation for publish profile
*socialPropertyIds* - array of integer values indicating social properties associated with
publish profile
*targetingIds* - array of string values indicating the social network and the category to
target
A bad request returns a 400 error and the following response:

{
"status": 400,
"message": "Invalid data supplied."
}
A call that finds no publish macros returns the following response:

{
publishProfiles: []
}
83
Publish Macros Retrieve Publish Macro
Retrieve Publish Macro

This method retrieves information on a publish macro from an account.
/v3/publishprofiles/{id}
HTTP Method
GET
Request Parameters
*id* - string value indicating unique identifier for publish macro

GET /v3/publishprofiles/{id}
Sample Call
GET /v3/publishprofiles/740a25ea-0b57-11e3-8d6f-168170973bd5
Sample Response
{
id: 740a25ea-0b57-11e3-8d6f-168170973bd5,
"type": "publish",
"owner": 6834,
}

*type* - string value indicating type of profile
*publish*
*name* - string value indicating name of publish macro
*description* - string value indicating description of publish macro
*owner* - integer value indicating unique ID for publish macro owner
*created* - timestamp value indicating date of creation for publish macro
publish macro
84
Publish Macros Retrieve Publish Macro Attribute
target
Retrieve Publish Macro Attribute

This method retrieves hydrated information on a specified attributes from a publish macro in an account.
/v3/publishprofiles/{id}/{type}
HTTP Method
GET
Request Parameters
*id* - string value indicating unique identifier for publish macro (required)
*type* - string value indicating property to retrieve:
*targetingIds* - array of string values indicating the social network and the category
to target
*socialPropertyIds* - array of integer values indicating social properties associated
with publish macro
*webAnalytics* - array of key and value pairs indicating web analytical information
to include with publish macro

GET /v3/publishprofiles/{id}/{type}
Sample Call
GET /v3/publishprofiles/740a25ea-0b57-11e3-8d6f-168170973bd5/targetingIds
Sample Response
A successful call for targeting IDs returns the following response:
{
"targetingIds": [
"li_geo_af.dz",
"li_geo_af.eg"
],
"count": 9,
"next":
"{HOST}/v3/publishProfiles/0151bc2e-ee3d-4108-b7cf-b3bb0d207b91/targetingIds&page=2"
}
85
Publish Macros Create Publish Macro
A successful call for targeting IDs returns the following response:

{
"webAnalytics": [
{
"key": "another one",
"value": "another value"
},
{
"key": "third one",
"value": "third value"
},
{
"key": "ytm_dd",
"value": "ytm_value"
}
],
"count": 3,
"next": null
}

{
"status": 400,
}
A call that finds no publish macro returns the following response:

{
"status": "404",
"message": "publish macro not found"
}
Create Publish Macro

This method creates a publish macro within an account.
/v3/publishprofiles
HTTP Method
POST
Request Parameters
None
86
Publish Macros Create Publish Macro
JSON Parameters
*name* - string value indicating name of publish macro (required)

*description* - string value including description of publish macro (required)
publish macro
*youtubePlaylists* - array of key and value pairs indicating the account and playlists
associated with the publish macro
target
*webAnalytics* - array of key and value pairs indicating web analytical information to
include with publish macro

POST /v3/publishprofiles
Sample Request
curl -X POST {HOST}/v3/publishprofiles
{
"description": "My Publish Profile Description",
"socialPropertyIds": ['3211', '4567'],
"youtubePlaylists": [
{
"key" : "3211",
"value" : "11"
},
{
"key" : "3211",
"value" : "22"
}
],
"targetingIds": ['li_ag', 'fb_nj'],
"webAnalytics": [
{
"key" : "sample_key",
"value" : "sample_value"
},
{
"key" : "sample_key2",
"value" : "sample_value2"
}
]
}
87
Publish Macros Delete Publish Macro
Sample Response
A successful call returns an ID value for the newly created publish macro:
{
"id":"5239534f-0b58-11e3-8d6f-168170973bd5"
}

{
"status": 400,
}
Delete Publish Macro

This method deletes a publish macro from an account.
/v3/publishprofiles/{id}
HTTP Method
DELETE
Request Parameters

DELETE /v3/publishprofiles/{id}
Sample Call
curl -X DELETE {HOST}/v3/publishprofiles/740a25ea-0b57-11e3-8d6f-168170973bd5
Sample Response
{
true
}
88
Publish Macros Delete Publish Macro
A call that finds no publish macro returns the following response:

{
"status": "404",
"message": "publish macro not found"
}
A call from a user without permission to remove the publish macro returns the following response:
{
"status": "403",
"code": "error.FORBIDDEN",
"message": "Unauthorized to view profile"
}
89
CHAPTER 11 Approval Rules
In this chapter ... Approval rules gate actions (such as publishing a post) until certain individuals provide approval. Approval
rules are made up of three end-points:
Retrieve Approval
Rules
1. /v1/approvalflows
Retrieve Approval
2. /v1/approvalprerequisites
Rule 3. /v1/approvalprocedures
Create Approval Rule
Update Approval
Rule Sample Workflow
Delete Approval Rule
Retrieve Approval Approval rules define the name and priority of the rule. Prioritizing rules allows for multi-step approvals.
Rule Criteria For example, your rule could require that you first get approval from the Creative Team (rule 1), then get
Update Approval approval from the Legal OR from the Director of Social (rule 2).
Rule Criteria Define the criteria to trigger the rule within approval prerequisites (such as a user or social account in
Retrieve Approvers the workspace).
for a Rule Finally, approval pocedures define the approvers of the rule.
Update Approvers
for a Rule
Create a Rule
Lets start by creating a rule, including criteria (prerequisites) and approvers (procedures).
Create an approval rule cURL Example

curl -X POST -H "access_token: a78cabb9-c00e-4f98-9127-248003a7d9a1"
"name": "My Approval Rule",
"trigger" : "Publish",
"priority" : "21",
"workspace" : "b8e4c9c4-9e3c-411f-ae80-7c2b3d6e2ab0"
}' 'https://api.socialstudio.radian6.com/v1/approvalflows'
Create the criteria that triggers the rule cURL Example

curl -X PUT -H "access_token: a78cabb9-c00e-4f98-9127-248003a7d9a1"
-d '{
"items": [
90
Approval Rules
{
"criteria": "submitter",
"operator": "equals",
"argument": "79799125
},
{
"criteria": "social account",
"argument": 79798915"
},
{
"argument": "{{social_property2}}"
}
],
"query": "(1 AND 2) OR ( 1 AND 3 )"
}'
'https://api.socialstudio.radian6.com/v1/approvalprerequisites/1d9217cf-40f4-4f8d-b465-9c4542209c20'
Define the Approvers of the Rule cURL Example

curl -X PUT -H "access_token: 63ae7c90-2927-470c-9ce4-e2489d6e992b"
"items": [
{
"criteria": "user",
"argument": "79799125",
"action": "approve"
},
{
"criteria": "user",
"argument": "79799126",
"action": "approve"
},
{
"criteria": "user",
"argument": "79799127",
"action": "approve"
}
],
"query": "(1 AND 2) OR ( 1 AND 3 )"
}'
'https://api.socialstudio.radian6.com/v1/approvalprocedures?approvalflow=1d9217cf-40f4-4f8d-b465-9c4542209c2'
91
Approval Rules Retrieve Approval Rules
Retrieve Approval Rules

This method retrieves one or more approval rules for a workspace.
/v1/approvalflows
HTTP method
GET
Request Parameters
*ownerId* - identifies the workspace from which to retrieve the approval rules (required)
*ownerType* - identifies the object from which to retrieve the approval rules (required).
Possible values include the following:
*workspace*
*include* - idenfies optional additional information on the workflow. Possible values
include the following:
*prerequisite* - displays array value of rules within approval rule
*procedure* - returns array value of procedures
*approverCount* - returns integer value of approvers for approval rule
*criteriaCount* - returns integer value of criteria for approval rule
*page* - indicates optional number of pages to provide for results
*perpage* - indicates optional number of results to provide per page

GET {HOST}/v1/approvalflows
Sample Request
GET /v1/approvalflows?ownerId=a272b824-bbf7-4a8c-bb1e-3d9695f3032a&ownerType=workspace
Sample Response
{
"status": true,
"response": [
{
"id": "d460106d-794b-11e3-b8e3-168170973bd5",
"ownerId": "92ed3d44-5376-11e3-b8e3-168170973bd5",
"ownerType": "workspace",
"priority": 1,
"triggerAction": "publish",
"name": "My Approval Flow"
92
},
{
"id": "b64ee373-81f0-11e3-b8e3-168170973bd5",
"priority": 2,
"name": "My Other Approval Flow"
}
],
"meta": {
"total": 2,
"page": 1,
"perpage": 2,
"current":
"HOST/v1/approvalflows?workspace=92ed3d44-5376-11e3-b8e3-168170973bd5&page=1",
"prev": "",
"next": ""
}
}
A successful call with include parameters returns the following response:

{
"status": true,
"response": [
{
"id": "d460106d-794b-11e3-b8e3-168170973bd5",
"priority": 99,
"name": "Workflow get with include",
"prerequisite": {
"items": [
{
"argument": 7664
},
{
"argument": 7641
},
{
"criteria": "language",
"argument": 60
},
{
"criteria": "language",
"argument": 61
}
93
],
"query": "1 and 2 and ( 3 or 4 )"
},
"procedure": [],
"meta": {
"criteriacount": "4"
"approvercount": "1"
}
}
],
"meta": {
"total": 1,
"page": 1,
"perpage": 1,
"current":
"HOST/v1/approvalflows?include=prerequisite,procedure&workspace=92ed3d44-5376-11e3-b8e3-168170973bd5&page=1",
"prev": "",
"next": ""
}
}

*response* - array of information related to retrieved approval rules:
*id* - string value indicating ID of approval rule
*ownerId* - string value indicating ID of approval rule owner
*ownerType* - string value indicating entity type of approval rule owner
*priority* - integer value indicating priority for approval rule
*triggerAction* - string value indicating action that begins approval rule
*name* - string value indicating name of approval rule
*prerequisites* - array indicating rules contained within approval rule:
*criteria* - string value indicating object within rule
*operator* - string value indicating whether criteria EQUALS or NOT EQUALS the supplied
argument value
*argument* - string value to compare with criteria
*query* - string values indicating AND or OR for query with supplied criteria
Error Responses
A call including an invalid or unsupported argument key and value pair returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": "An invalid parameter/value was supplied"
}
]
},
"meta": []
}
94
Approval Rules Retrieve Approval Rule
Ensure that your call includes only valid values.

A call not including an expected argument returns the following repsonse:
{
"status": false,
"response": {
"errors": [
{
"message": "An expected argument was not supplied"
}
]
},
"meta": []
}
Ensure that your call includes all required values.

A call attempting to view a workspace without the proper permissions returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": "Unathorized to view workspace"
}
]
},
"meta": []
}
Retrieve Approval Rule

This method retrieves one or more approval rules for a workspace.
/v1/approvalflows/{id}
HTTP method
GET
Request Parameters
*id* - identifies the approval rule to retrieve (required)

*include* - identifies optional additional information on the workflow. Possible values
include the following:
*prerequisite* - displays array value of rules within approval rule
*procedure* - returns array value of procedures
95
*approverCount* - returns integer value of approvers for approval rule

*criteriaCount* - returns integer value of criteria for approval rule
*hydrate=argument - indicates that the call should return related entity information instead
of string or integer IDs

GET {HOST}/v1/approvalflows/{id}
Sample Request
GET
/v1/approvalflows?ownerId=a272b824-bbf7-4a8c-bb1e-3d9695f3032a&include=prerequisite,procedure,approvercount,criteriacount&hydrate=argument
Sample Response
{
"status": true,
"response": {
"id": "d460106d-794b-11e3-b8e3-168170973bd5",
"priority": 171,
"name": "My Approval Flow"
}
}
A successful call with include parameters returns the following response:

{
"status": true,
"response": {
"id": "e1c69b8c-6844-43fb-9eb3-0fe30dd92cc3",
"ownerId": "7046e184-0bd1-4c88-9255-642d8a212f31",
"priority": 7,
"name": "testworkflowapi",
"prerequisite": {
"items": [
{
"argument": 6721
},
{
96
"argument": "1a4ebec4-7b11-4d0a-aad3-4fc859ba8e28"
},
{
"argument": "d5594362-829d-49c6-b317-6675b9a280f8"
}
],
"query": "( 1 and 2 ) or 3"
},
"procedure": {
"items": [
{
"criteria": "user",
"argument": 6721,
"action": "approve"
},
{
"criteria": "user",
"argument": 6721,
"action": "approve"
}
],
"query": "1 or 2"
},
"meta": {
"criteriacount": "4"
"approvercount": "1"
}
},
"meta": []
}
A successful call with include parameters and the hydrate argument returns the following response:
{
"status": true,
"response": {
"id": "e1c69b8c-6844-43fb-9eb3-0fe30dd92cc3",
"ownerId": "7046e184-0bd1-4c88-9255-642d8a212f31",
"priority": 7,
"name": "testworkflowapi",
"prerequisite": {
"items": [
{
"argument": {
"id": 6721,
"email": "pboddu@example.com",
"username": "pboddu@example.com",
97
"title": "PraveenBoddu",
"display_name": "PraveenBoddu",
"timezone": "GMT",
"enabled": true,
"updated": "2014-02-26T20:14:47+0000",
"organization_id": 10545
}
},
{
"argument": null
},
{
"argument": null
}
],
"query": "( 1 and 2 ) or 3"
},
"procedure": {
"items": [
{
"criteria": "user",
"argument": {
"id": 6721,
"timezone": "GMT",
"enabled": true,
"updated": "2014-02-26T20:14:47+0000",
},
"action": "approve"
},
{
"criteria": "user",
"argument": {
"id": 6721,
"timezone": "GMT",
"enabled": true,
"updated": "2014-02-26T20:14:47+0000",
},
"action": "approve"
98
}
],
"query": "1 or 2"
}
},
"meta": []
}

*response* - array of information related to retrieved approval rules:
*id* - string value indicating ID of approval rule
*ownerId* - string value indicating ID of approval rule owner
*ownerType* - string value indicating entity type of approval rule owner
*priority* - integer value indicating priority for approval flow
*triggerAction* - string value indicating action that begins approval rule
*name* - string value indicating name of approval rule
*prerequisites* - array indicating rules contained within approval rule:
*operator* - string value indicating whether criteria EQUALS or NOT EQUALS the
supplied argument value
The information provided with the hydrate argument varies depending on the included entities.
Error Responses
An unsuccessful call will return one of the following error responses:
{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}

{
"status": false,
"response": {
"errors": [
{
99
Approval Rules Create Approval Rule
}
]
},
"meta": []
}

A call attempting to view a workspace without the proper permissions returns the following response:
{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}
Ensure that you include the proper authentication with your call.
Create Approval Rule

This method creates an approval rile for a workspace.
/v1/approvalflows
HTTP method
POST
Request Parameters
None
Query Parameters
*workspace* - ID for the workspace (required)

*trigger* - identifies the event that begins the workflow process. This parameter accepts
the following string values:
*publish*
*name* - identifies the name of the workflow. This parameter accepts any unique string
value for a specific owner that does not include the < or > characters.
*priority* - accepts an optional integer value that sets the priority for the workflow
100

POST {HOST}/v1/approvalflows
Sample Request
POST /v1/approvalflows HTTP/1.1
Host: HOST
trigger=publish&workspace=92ed3d44-5376-11e3-b8e3-168170973bd5&priority=9&name=My+Approval+Flow
Sample Response
{
"status": true,
"response": {
"id": "d460106d-794b-11e3-b8e3-168170973bd5"
},
"meta": []
}

*id* - string value indicating ID for newly created approval rile
Error Responses
{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}

A call attempting to create or update an entity that already uses the same unique identifiers returns the following response:
{
"status": false,
"response": {
101
"errors": [
{
"message": "A duplicate entry was detected when saving"
}
]
},
"meta": []
}
Ensure that your new call includes a unique value.
Missing Argument
{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}
Unauthorized to Add Approval Flow

A call attempting to add an approval rile without the proper permissions returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": "Unathorized to remove"
}
]
},
"meta": []
}
A call attempting to view a non-existant workflow returns the following response:
{
"status": false,
"response": {
102
Approval Rules Update Approval Rule
"errors": [
{
}
]
},
"meta": []
}
Update Approval Rule

This method updates an existing approval rule.
/v1/approvalflows/{id}
HTTP Method
PATCH
Request Parameters
*id* - ID for the approval rule (required)

*name* - identifies the name of the workflow. This parameter accepts any unique string
value for a specific owner that does not include the < or > characters.
*priority* - accepts an optional integer value that sets the priority for the workflow
Request Parameter Examples

PATCH /v1/approvalflows/{id}
Sample Request
This sample request updates an approval rule with a priority of 2:
curl -X PATCH -d "priority=2" {HOST}/v1/approvalflows/d460106d-794b-11e3-b8e3-168170973bd5
Sample Response
{
"status": true,
"response": true,
103
Approval Rules Update Approval Rule
"meta": []
}

*response* - string value indicating update of approval rule
Error Responses
An unsuccessful call will return one of the following responses:
{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}

A call attempting to create or update an entity that already uses the same unique identifiers returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": "A duplicate entry was detected when saving"
}
]
},
"meta": []
}
Ensure that your new call includes a unique value.

A call attempting to modify an approval rule without the proper permissions returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": "Unathorized to modify"
}
]
104
Approval Rules Delete Approval Rule
},
"meta": []
}
A call attempting to view a non-existant workflow returns the following response:
{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}
Delete Approval Rule

This method deletes an existing approval rule.
/v1/approvalflows
HTTP method
DELETE
Request Parameters

DELETE /v1/approvalflows/{id}
Sample Request
DELETE {HOST}/v1/approvalflows/d460106d-794b-11e3-b8e3-168170973bd5
105
Approval Rules Delete Approval Rule
Sample Response
{
"status": true,
"response": true,
"meta": []
}

*response* - string value indicating deletion of approval rule
Error Responses
An unsuccessful call will return one of the following responses:
{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}

{
"status": false,
"response": {
"errors": [
{
}
]
},
"meta": []
}

A call attempting to remove an approval rule without the proper permissions returns the following response:
{
"status": false,
106
Approval Rules Retrieve Approval Rule Criteria
"response": {
"errors": [
{
"message": "Unathorized to remove"
}
]
},
"meta": []
}
Retrieve Approval Rule Criteria

This method retrieves criteria that will trigger an approval flow.
/v1/approvalprerequisites/{workflowId}
HTTP method
GET
Request Parameters
*workflowId* - ID for the approval flow (required)

GET /v1/approvalprerequisites/{workflowId}
Query Parameters
Sample Request
GET {HOST}/v1/approvalprerequisites/46e66860-25fe-11e3-b1a1-168170973bd5
GET {HOST}/v1/approvalprerequisites/46e66860-25fe-11e3-b1a1-168170973bd5&hydrate=argument
107
Sample Response
{
"status": true,
"response": {
"items": [
{
"argument": 123123
},
{
"argument": 83967
},
{
"argument": 84975
}
],
"query": "(1 AND 2) OR ( 1 AND 3 )"
},
"meta": []
}
A successful call including the hydrate argument returns the following response:
{
"status": true,
"response": {
"items": [
{
"argument": {
"id": 7664,
"email": "qzhen@example.com",
"title": "Qzhen_10100",
"avatar_url": null,
"timezone": "GMT",
"enabled": true,
"updated": "2014-02-04T15:50:42+0000",
"organization_id": 10100,
"roles": 1
}
},
{
"operator": "in",
"argument": [
{
108
"name": "Exercise_Your_Voting_Right",
"id": "541a6b23-21ff-4c2c-9ed0-ca81da98d71d",
"network": "Facebook",
"asset": "519296421491495",
"socialaccount": 94093,
"tokenStatus": 1,
"metadata": {
"pageLogo":
"https://fbcdn-profile-a.akamaihd.net/static-ak/rsrc.php/v2/yg/r/LjGkeBM0ISt.png",
"provider": "FACEBOOK",
"userName": "/Exercise_Your_Voting_Right/519296421491495"
}
},
{
"name": "Example Page",
"id": "3a65a221-c16e-479b-8430-57b46fcb21f2",
"network": "Facebook",
"asset": "407001072724791",
"socialaccount": 94268,
"tokenStatus": 1,
"metadata": {
"pageLogo":
"https://fbcdn-profile-a.akamaihd.net/static-ak/rsrc.php/v2/yg/r/LjGkeBM0ISt.png",
"provider": "FACEBOOK",
"userName": "/Chris-Dev-Page/407001072724791"
}
}
]
},
{
"argument": {
"id": "83967",
"link":
"https://stg3-api.dev.ca1.sfmc.co/socialcloud/v2/socialProperties/83967",
"updated": "2015-04-20T14:45:35Z",
"title": "Ana-192",
"topic": {
"id": "83967",
"link":
"https://stg3-api.dev.ca1.sfmc.co/socialcloud/v2/topics/83967",
"updated": "2015-02-19T17:06:49Z",
"title": "Ana-192",
"createdDate": "2015-02-19T17:06:49Z"
},
"creator": {
"id": "79798023",
"link":
"https://stg3-api.dev.ca1.sfmc.co/socialcloud/v2/users/79798023",
"updated": "2015-04-20T14:45:35Z",
"title": "Hiren Gosalia",
"email": "hgosalia@salesforce.com",
"avatarURL": null
109
},
"projects": [],
"registration": {
"id": "16243",
"link":
"https://stg3-api.dev.ca1.sfmc.co/socialcloud/v2/socialAccounts/16243",
"updated": null,
"title": "Mansi SFDC",
"lastRefreshedTime": null
},
"lastValidatedTime": null,
"avatar":
"https://media.licdn.com/mpr/mpr/p/7/005/086/041/07b736a.png",
"usedBySalesforce": "false",
"uniqueName": "ana-192",
"realName": "Mansi SFDC",
"socialNetwork": {
"id": "3880369",
"name": "LinkedIn Page",
"type": 25
},
"status": 0,
"tokens": {
"tokenStatusId": 0,
"tokenStatusLastUpdate": null
}
}
}
}
],
"query": "1 AND ( 2 OR 3 )"
},
"meta": []
}

*response* - array of information related to retrieved rules:
*items* - array indicating information contained within rule:
A call that cannot find the indicated approval flow returns the following response:
{
"status": false,
"response": {
"errors": [
{
110
Approval Rules Update Approval Rule Criteria
"message": ""
}
]
},
"meta": []
}
A call that references an unauthorized approval flow returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}
Update Approval Rule Criteria

This method updates criteria that will trigger an approval flow.
/v1/approvalprerequisites/{approvalflow}
HTTP method
PUT
Request Parameters
*approvalflow* - ID for the approval flow (required)

PUT {HOST}/v1/approvalprerequisites/46e66860-25fe-11e3-b1a1-168170973bd5
JSON Parameters
Each JSON payload includes two arguments:
*items* - array of criteria to add or update to the approval flow
111
The *items* array includes individual items with the following values:
*criteria* - string value indicating the subject of the rule. Acceptable values include
the following:
*label* - label associated with object
*submitter* - user ID for person performing submit action
*social account* - social property ID associated with the object
*language* - language associated with the object
*country* - country associated with the object
*operator* - string value indicating whether the rule subject equals or does not equal
the provided value
*equals*
*not equals*
*argument* - string value to match against the *criteria* value. *argument* can accept
empty values for label, country, and language. *argument* cannot accept empty values for
*submitter* or *social account*.
*query* - string value indicating how approval workflow handles criteria
The *query* argument includes integers, logical operators, and appropriate groupings.
*integer* - position of criteria in *items* array, beginning with 1
*logical operators* - AND or OR value indicating grouping of criteria
*grouping* - Use parantheses to group together integers and logical operators. You
cannot use AND and OR in the same grouping.
Sample Request
PUT {HOST}/v1/approvalprerequisites/46e66860-25fe-11e3-b1a1-168170973bd5
{
"items": [
{
"argument": 123123
},
{
"argument": 68304
},
{
"argument": 68647
}
],
"query": "(1 AND 2) OR ( 1 AND 3 )"
}
112
Sample Response
{
"status": true,
"response": true,
"meta": []
}

*response* - string value indicating update of approval flow
A call referencing a nonexistant approval flow returns the following response:

{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}
A call not authorized to modify the approval flow returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}
A call including incorrect arguments returns the following response:

{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
113
Approval Rules Retrieve Approvers for a Rule
"meta": []
}
Retrieve Approvers for a Rule

This method retrieves the criteria that will trigger a specific approval rule.
/v1/approvalprocedures/{id}
HTTP method
GET
Request Parameters

GET /v1/approvalprocedures/{id}
Query Parameters
Sample Request
This sample request retrieves the specified approval rule:
curl GET {HOST}/v1/approvalprocedures/aab75fac-0453-11e3-8d6f-168170973bd5
Sample Response
{
"status": true,
"response": {
"items": [
{
"criteria": "user",
"argument": 123123,
114
"action": "approve"
},
{
"criteria": "user",
"argument": 8765,
"action": "approve"
},
{
"criteria": "user",
"argument": 425548144218779,
"action": "approve"
}
],
"query": "(1 AND 2) OR ( 1 AND 3 )"
},
"meta": []
}
A successful call with the hydrate argument returns the following response:
{
"status": true,
"response": {
"items": [
{
"criteria": "user",
"argument": {
"id": 6721,
"avatar_url": null,
"timezone": "GMT",
"enabled": true,
"updated": "2014-02-07T18:59:47+0000",
},
"action": "approve"
},
{
"criteria": "user",
"argument": {
"id": 6721,
"avatar_url": null,
"timezone": "GMT",
"enabled": true,
115
"updated": "2014-02-07T18:59:47+0000",
},
"action": "approve"
},
{
"criteria": "user",
"argument": {
"id": 6721,
"avatar_url": null,
"timezone": "GMT",
"enabled": true,
"updated": "2014-02-07T18:59:47+0000",
},
"action": "approve"
}
],
"query": "1 and ( 2 or 3 )"
},
"meta": []
}

*response* - array of information related to retrieved rules:
*items* - array indicating information contained within rule:
*action* - string value indicating action performed via rule
Error Responses
A call referencing an unknown approval rule returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
116
Approval Rules Update Approvers for a Rule
},
"meta": []
}
Ensure that you reference the correct ID for the approval rule.
A call referencing an approval rule without authorization returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}
Ensure you use the correct authentication information.
Update Approvers for a Rule

This method updates the approvers for a specified approval rule.
/v1/approvalprocedures/{id}
HTTP method
PUT
Request Parameters

PUT /v1/approvalprocedures/{id}
JSON Parameters
Each JSON payload includes two arguments:
*items* - array of criteria to add or update to the approval rule
The *items* array includes individual items with the following values:
117
*criteria* - string value indicating this call affects a specified user. Use only the
*user* value here.
*argument* - string value to match against the *criteria* value. *argument* can accept
empty values for label, country, and language. *argument* cannot accept empty values for
*submitter* or *social account*.
*action* - indicates the action for the rule. Acceptable values include the following:
*approve*
*query* - string value indicating how approval workflow handles criteria
The *query* argument includes integers, logical operators, and appropriate groupings.
*integer* - position of criteria in *items* array, beginning with 1
*logical operators* - AND or OR value indicating grouping of criteria
*grouping* - Use parantheses to group together integers and logical operators. You
cannot use AND and OR in the same grouping.
Sample Request
curl -X PUT {HOST}/v1/approvalprocedures/46e66860-25fe-11e3-b1a1-168170973bd5
{
"items": [
{
"criteria": "user",
"argument": 123123,
"action": "approve"
},
{
"criteria": "user",
"argument": 8765,
"action": "approve"
},
{
"criteria": "user",
"argument": 425548144218779,
"action": "approve"
}
],
"query": "(1 AND 2) OR ( 1 AND 3 )"
}
Sample Response
{
"status": true,
118
"response": true,
"meta": []
}

*response* - string value indicating update of approval rule
Error Responses
A call referencing an unknown approval rule returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}
Ensure you used the correct ID for the approval rule.

A call referencing an approval rule without authorization returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
"meta": []
}
Ensure you use the correct authentication information.

A call referencing a bad request returns the following response:
{
"status": false,
"response": {
"errors": [
{
"message": ""
}
]
},
119
"meta": []
}
Ensure you properly formatted the information included in the call.
120
CHAPTER 12 Social Properties
In this chapter ... The Social Properties endpoint allows you to retrieve a list of social accounts registered in your Social
Studio organization. The call returns only those social accounts available to you based on user permissions
Retrieve Properties and role.
Retrieve Property
Retrieve All Accounts

Users can retrieve a list of all shared and owned accounts.
GET v3/socialProperties
cURL Example
curl -X GET -H "access_token: 99203c04-621c-4b43-99e4-b76e121faddc"
'https://api.socialstudio.radian6.com/v3/socialProperties?view=shared&owned'
Retrieve a Single Account

You can also retrieve information on a specific account:
GET v3/socialProperties/{id}
cURL Example
curl -X GET -H "access_token: 99203c04-621c-4b43-99e4-b76e121faddc"
'https://api.socialstudio.radian6.com/v3/socialProperties/6386'
121
Social Properties Retrieve Properties
Retrieve Properties
This method retrieves social properties the user can access. This object contains information about a managed account topic profile and
associated external user account.
/v3/socialProperties
HTTP Method
GET
Request Parameters
*view* - string value including comma-separated list of properties to return (defaults to

OWNED;(only those properties created by requesting user))
*OWNED* - all social properties created by requesting user
*SHARED* - all social properties shared with and not owned by requesting user
*types* - integer value indicating return of social properties with specified social network
types
*3* - Twitter
*4* - Facebook
*24* - Google Plus
*25* - LinkedIn
*27* - Sina Weibo
*28* - YouTube
*29* - Instagram
*30* - Pinterest
*workspaceGroupId* - reserved for internal use
*limit* - integer value indicating number of results to return (defaluts to 25)
*offset* - integer value indicating result to start with in returned results
*status* - string value including comma-separated list of integers indicating return of
social properties with specified status values
*invalidAccountsFirst* - boolean value indicating return of *invalid* values first, then
*OK* and *new* values (defaults to false)
*orderBy* - string value indicating fields used to sort returned social properties:
*title* - string value describing post
*creator* - string value including creator of post
*visibility* - string value indicating visibility of post*
*status* - integer value indicating status of post
*q* - string value including search string query (minimum of three characters), indicates
return of social properties with partial case-insensitive match on topic title or creator
name
*ids* - string value indicating comma-delimited list of valid social proeprty IDs to return.
Only returns visible social properties. The call returns a 404 error if no social properties
are available. The call normalizes duplicate values and ignores all other query parameters.
122
Social Properties Retrieve Properties
Request Parameter Sample

GET /v3/socialProperties
Sample Request
GET /v3/socialProperties?types=4
Sample Response
{
"data": [
{
"id": "121218",
"displayName": "Jane's test software",
"pageUrl": "https://facebook.com/pages/Janes-test-softwar/128544450650919",
"networkTypeId": 4,
"avatarUrl":
"https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xaf1/v/t1.0-1/c151.34.422.422/s50x50/552488_128545593954160_2159838340_n.jpg?oh=cb08f9353545f1bb437f96022466a235&oe=563DA948&__gda__=1448168411_3a661fa573372b8fc3b31058feeb6c8c",
"slug": "pages/Janes-test-software/128544450650919",
"valid": true
},
{
"id": "111819",
"displayName": "I Heart CBC NB",
"pageUrl": "https://facebook.com/pages/I-Love-CBC-NB/376189652448432",
"networkTypeId": 4,
"avatarUrl":
"https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xfa1/v/t1.0-2/p50x50/305074_380514875349292_382752874_n.jpg?oh=02eb66e27be49c4d3a99576b4997493b&oe=5651FCB9&__gda__=1447361104_cbbb529d940f10185f2877dd306967de",
"slug": "pages/I-Love-CBC-NB/376189652448432",
"valid": true
}
],
"meta": {
"totalCount": 2
}
}
*id* - string value indicating unique ID for social property

*displayName* - string value containing name of social property
*pageUrl* - string value containing URL of social property on social network
*networkTypeId* - integer value indicating social network type
*avatarUrl* - string value containing location of avatar image file
*slug* - string value containing slug for social property
*valid* - boolean property indicating whether social media account remains active and valid
123
Social Properties Retrieve Property
Retrieve Property
This method retrieves a single social property from those available for the user to access. This object contains information about a
managed account topic profile and associated external user account. The socialPropertyId value equals the managed account topic
profile ID.
/v3/socialProperties/{id}
HTTP Method
GET
Request Parameters
*id* - integer value indicating the ID for the social property to retrieve

GET /v3/socialProperties/{socialPropertyId}
Sample Request
GET /v3/socialProperties/121218
Sample Response
{
"data": [
{
"id": "121218",
"displayName": "Jane's test software",
"pageUrl": "https://facebook.com/pages/Janes-test-softwar/128544450650919",
"networkTypeId": 4,
"avatarUrl":
"https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xaf1/v/t1.0-1/c151.34.422.422/s50x50/552488_128545593954160_2159838340_n.jpg?oh=cb08f9353545f1bb437f96022466a235&oe=563DA948&__gda__=1448168411_3a661fa573372b8fc3b31058feeb6c8c",
"slug": "pages/Janes-test-software/128544450650919",
"valid": true
},
],
"meta": {
"totalCount": 1
124
Social Properties Retrieve Property
}
}
*id* - string value indicating unique ID for social property

*displayName* - string value containing name of social property
*pageUrl* - string value containing URL of social property on social network
*networkTypeId* - integer value indicating social network
*avatarUrl* - string value containing location of avatar image file
*slug* - string value containing slug for social property
*valid* - boolean property indicating whether social media account remains active and valid
125
CHAPTER 13 Create Topic Profile and Retrieving Posts with
Keyword Groups
In this chapter ...
Create Topic Profile
Retrieve Topic Profiles
Retrieve Topic Profile Use the topic profile to define the social data that interests you based on a set of parameters consisting
of keywords, sources, languages, regions and media types. For example, you could look for a series of
English keywords in Twitter posts originating in the United Kingdom.
Update Topic Profile
First, define the topic profile using the following route:
Delete Topic Profile
Update Keyword POST /v3/topics
Groups in a Topic
Profile
Delete Keyword cURL Example
Groups in a Topic
Profile curl -X POST -H 'access_token: your_access_token" -H "Content-Type:
Update Source Filters application/json" -d '{
in a Topic Profile "title" : "test12345",
"languages" : [ "1" ],
Activate a Topic
"mediaTypes" : [ {"id" : "5" }, { "id" : "1" }, { "id" : "10" } ]
Profile
}' https://api.socialstudio.radian6.com/v3/topics
Create Keyword Group

Next, create a keyword group that contains the keywords to be monitored. Keywords allow you to define
specific terms which should match post content and define which content flows to the topic profile.
Social Studio organizes keywords into various keyword groups using the following route:
POST /v3/keywordGroups
cURL Example
"title" : "API Test",
"type" : 2,
"active" : true,
"contains" : [[{"tokenType" : 1, "value" : "Coca Cola", "meta" :
126
Create Topic Profile and Retrieving Posts with Keyword
Groups
"2" }]]
}' https://api.socialstudio.radian6.com/v3/keywordGroups
Assign Keyword Group to Topic Profile

After creating a topic profile and a keyword group, you can link them both together using the following
API endpoint:
PUT /v3/topics{id}/keywordGroups
cURL Example
curl -X PUT -H "access_token: your_access_token" -H "Content-Type:
application/json" -d '[
{
"id" : "405492"
}]'
https://api.socialstudio.radian6.com/v3/topics/273382/keywordGroups
Retrieving Posts
Once you create the previous calls, you can retireve matching posts:
GET /v3/posts?topics={id}
cURL Example
curl -X GET -H "access_token: your_access_token" -H "Content-Type:
application/json"
https://api.socialstudio.radian6.com/v3/posts?topics=273382
Each client can use a limited amount of active topic profiles. Any call that causes the client to exceed
the limit returns a 400 error.
127
Create Topic Profile and Retrieving Posts with Keyword Retrieve Topic Profiles
Groups
Retrieve Topic Profiles

This method retrieves specific details on topic profiles based on user permissions and role. You cannot use this route to retrieve information
on keywords and keyword groups.
/v3/topics
HTTP Method
GET
Request Parameters
None
Query Parameters
*workspaceGroupId* - reserved for internal use

*limit* - integer value indicating number of results to return (defaults to 50000)
*includeQuickSearch* - boolean value indicating whether to include Quick Search topic
profiles in response
*orderBy* - string values indicating how call sorts returned list of topic profiles:
*title*
*visibility*
*status*
*created* (ordered alphabetically by display name of creator)
*creation* (topic ordered by topic creation date)
*ASC* (default)
*DESC*
*status* - integer values indicating status of topic profile to return
*0* - disabled
*1* - purchased or active
*2* - trial
*3* - expired
*4* - draft

GET /v3/topics
Sample Call
GET /v3/topics?q="Scott"&includeQuickSearch=false
128
Create Topic Profile and Retrieving Posts with Keyword Retrieve Topic Profiles
Groups
Sample Response
{
"data": [
{
"id": "4",
"title": "Scott Test 3",
"creator": {
"id": "3",
"link": "https://stg2-dmz3.dev.ca1.example.co/socialcloud/v2/users/3",
"updated": null,
"title": "scott@example.com (clientId = 1)"
},
"status": 1,
"emv": 0,
"languages": [],
"mediaTypes": [],
"regions": [],
"keywordGroups": [],
"billingCode": "",
"includeSourceFilters": [],
"excludeSourceFilters": [],
"includeAllSourceFilters": [],
"createdDate": "2009-10-09T19:27:58Z"
},

],
"meta" : {
"totalCount" : 52
}
}
*id* - integer value indicating unique ID for topic profile

*title* - string value indicating name of topic profile
*creator* - object containing information on creator of topic profile:
*id* - integer value indicating unique ID for creator
*link* - string value indicating URL for location of creator
*updated* - timestamp value indicating last update for creator (can be null)
*title* - string value indicating name of creator
*visibility* - string value indicating visibility of topic profile
*public*
*private*
*0* - disabled
*2* - trial
*3* - expired
*4* - draft
*emv* - integer value indicating estimated monthly value for topic profile
*languages* - array of language values associated with topic profile
*mediaTypes* - array of media type values associated with topic profile
129
Create Topic Profile and Retrieving Posts with Keyword Retrieve Topic Profile
Groups
*regions* - array of region values associated with topic profile

*keywordGroups* - array of keyword group values associated with topic profile
*billingCode* - string value of billing code associated with topic profile
*includeSourceFilters* - array of source filters associated with topic profile
*excludeSourceFilters* - array of source filters specifically excluded from topic profile
*includeAllSourceFilters* - array of all source filters available for topic profile
Retrieve Topic Profile

This method retrieves a specific topic profile based on user permissions and role. You cannot use this route to retrieve information on
keywords and keyword groups.
/v3/topics/{id}
HTTP Method
GET
Request Parameters

GET /v3/topics{id}
Sample Call
GET /v3/topics/4
Sample Response
{
"data": [
{
"id": "4",
"title": "Scott Test 3",
"creator": {
"id": "3",
"link": "https://stg2-dmz3.dev.ca1.example.co/socialcloud/v2/users/3",
"updated": null,
"title": "scott@example.com (clientId = 1)"
},
130
Create Topic Profile and Retrieving Posts with Keyword Create Topic Profile
Groups
"status": 1,
"emv": 0,
"languages": [],
"mediaTypes": [],
"regions": [],
"keywordGroups": [],
"billingCode": "",
"includeSourceFilters": [],
"excludeSourceFilters": [],
"includeAllSourceFilters": [],
"createdDate": "2009-10-09T19:27:58Z"
},

],
"meta" : {
"totalCount" : 52
}
}

*title* - string value indicating name of topic profile
*creator* - object containing information on creator of topic profile:
*id* - integer value indicating unique ID for creator
*link* - string value indicating URL for location of creator
*updated* - timestamp value indicating last update for creator (can be null)
*title* - string value indicating name of creator
*visibility* - string value indicating visibility of topic profile
*public*
*private*
*0* - disabled
*2* - trial
*3* - expired
*4* - draft
*emv* - integer value indicating estimated monthly value for topic profile
*languages* - array of language values associated with topic profile
*mediaTypes* - array of media type values associated with topic profile
*regions* - array of region values associated with topic profile
*keywordGroups* - array of keyword group values associated with topic profile
*billingCode* - string value of billing code associated with topic profile
*includeSourceFilters* - array of source filters associated with topic profile
*excludeSourceFilters* - array of source filters specifically excluded from topic profile
*includeAllSourceFilters* - array of all source filters available for topic profile

This method creates a new keyword topic profile.
/v3/topics
131
Create Topic Profile and Retrieving Posts with Keyword Create Topic Profile
Groups
HTTP Method
POST
Request Parameters
None

POST /v3/topics
JSON Parameters
*title* - string value indicating name for new topic profile (required)
*languages* - array of integer values indicating languages associated with new topic profile
(required, set with value of ALL to associate with all available values)
*mediaTypes* - array of integer values indicating media types associated with new topic
profile (required, set with value of ALL to associate with all available values)
*regions* - array of integer values indicating regions associated with new topic profile
*status* - integer value indicating status of topic profile (create with value of 4 for
DRAFT, otherwise leave blank)
Sample Request
POST /v3/topics
{
"title": "test topic profile",
"languages": [
"1"
],
"mediaTypes": [
{
"id": "5"
},
{
"id": "1"
},
{
"id": "10"
}
]
"regions": [
"all"
]
}
132
Create Topic Profile and Retrieving Posts with Keyword Update Topic Profile
Groups
Sample Response
A successful call returns a 201 Success code with a Location response header including the URL for the new topic profile resource.
A call including a malformed JSON payload or invalid IDs (such as unauthorized mediatypes) returns a 400 code. Ensure your JSON
payload contains valid values.
A call by a user with insufficient permissions returns a 403 code. Ensure your user can make this call within your organization.
An internal server error returns a 500 code. Try your code at a later time.
Update Topic Profile

This method updates a new keyword topic profile.
/v3/topics
HTTP Method
PUT
Request Parameters
None

PUT /v3/topics
JSON Parameters
*title* - string value indicating name for new topic profile (required)
*languages* - array of integer values indicating languages associated with new topic profile
*mediaTypes* - array of integer values indicating media types associated with new topic
profile (required, set with value of ALL to associate with all available values)
*regions* - array of integer values indicating regions associated with new topic profile
*status* - integer value indicating status of topic profile (create with value of 4 for
DRAFT, otherwise leave blank)
Sample Request
curl -X PUT -H "access_token: f0f59c64-a82d-4a76-8781-078952df8785" -H "Content-Type:
"title": "API Test TP",
"languages": [
133
Create Topic Profile and Retrieving Posts with Keyword Delete Topic Profile
Groups
"1"
],
"mediaTypes": [
{
"id": "5"
},
{
"id": "1"
},
{
"id": "10"
},
{
"id": "12"
}
]
}' 'https://{host}/v3/topics/1228'
Sample Response
A successful call returns a 200 Success code.
A call including a malformed JSON payload or invalid IDs (such as unauthorized mediatypes) returns a 400 code. Ensure your JSON
payload contains valid values.
A call by a user with insufficient permissions returns a 403 code. Ensure your user can make this call within your organization.
Delete Topic Profile

This method deletes an existing topic profile.
/v3/topics/{id}
HTTP Method
DELETE
Request Parameters

DELETE /v3/topics/{id}
134
Create Topic Profile and Retrieving Posts with Keyword Update Keyword Groups in a Topic Profile
Groups
Sample Request
DELETE /v3/topics/123459
Sample Response
A call including an invalid ID value returns a 404 code. Ensure your call contains valid values.
Update Keyword Groups in a Topic Profile

This method associated an existing keyword group with the specified topic profile.
/v3/topics/{topicProfileId}/keywordGroups
HTTP Method
PUT
Request Parameters
*topicProfileId* - integer value indicating the topic profile

PUT /v3/topics/{id}/keywordGroups
JSON Parameters
*keywordGroupId* - integer value indicating the keyword group (can include array of these
values)
Sample Request
curl -X PUT -H "Content-Type: application/json" -H "Accept: application/json"-H
"access_token: your_access_token" -d "[
{ \"id\" : \"408299\" }
]" "https://{host}/v3/topics/304237/keywordGroups"
135
Create Topic Profile and Retrieving Posts with Keyword Delete Keyword Groups in a Topic Profile
Groups
Sample Response
A call from a user with insufficient permissions to perform the update (either on topic profile or keyword groups)returns a 403 call.
Contact your administrator for the proper permissions.
A call including an invalid topic profile ID or keyword group ID returns a 404 error. Ensure you include the correct values in your call.
An internal server error during your call returns a 500 error. Try your call again at a later time.
Delete Keyword Groups in a Topic Profile

This method deletes a keyword group existing topic profile.
/v3/topics/{topicId}/keywordGroups/{keywordGroupId}
HTTP Method
DELETE
Request Parameters
*topicId* - integer value indicating unique ID for topic profile

*keywordGroupId* - integer value indicating unique UD for keyword group

DELETE /v3/topics/{id}/keywordGroups/{keywordGroupId}
Sample Request
DELETE /v3/topics/123459/keywordGroups/54321
Sample Response
Update Source Filters in a Topic Profile

This method updates the source filters associated with a topic profile.
/v3/topics/{id}/sourceFilters
136
Create Topic Profile and Retrieving Posts with Keyword Activate a Topic Profile
Groups
HTTP method
PUT
Request Parameters

PUT /v3/topics/{id}/sourceFilters
[
{
"sourceFilterId":2,
"type":1
}
]
JSON Parameters
*sourceFilterId* - The identifier for the source filter to be associated with the topic
profile
*type* - Source filter type
*0* - Include
*1* - Exclude
*2* - Include all
Sample Requests
Sample Response
Activate a Topic Profile

This method activates an existing topic profile.
/v3/topics/{id}
HTTP Method
POST
137
Create Topic Profile and Retrieving Posts with Keyword Activate a Topic Profile
Groups
Request Parameters

POST /v3/topics/{id}
Query Parameters
*action* - string value indicating action to perform on topic profile (required)

*activate*
*billingCode* - string value indicating billing code to associated with activation (required)
Sample Request
POST /v3/topics/12345?action=activate&billingCode=6789
Sample Response
138
CHAPTER 14 Keyword Groups
In this chapter ...
Retrieve Keyword
Groups
Create Keyword
Groups
Update Keyword
Groups
139
Keyword Groups Retrieve Keyword Groups
Retrieve Keyword Groups

This method returns a specified keyword group from a workspace.
/v3/keywordGroups/{id}
HTTP Method
GET
Request Parameters
*id* - integer value indicting unique ID for keyword group

GET /v3/keywordGroups/{id}
Sample Request
curl -X GET -H "Accept: application/json"-H "access_token: your_access_token"
"https://{host}/v3/keywordGroups/408299"
Sample Response
{
"data" : [
{
"title" : "Beverages",
"type" : 2,
"active" : true,
"contains" : [
[
{
"tokenType": 1,
"value": "soda",
"meta": "2"
},
{
"tokenType": 2
},
{
"tokenType": 0,
"value": "orange"
}
140
Keyword Groups Retrieve Keyword Groups
],
[
{
"tokenType": 1,
"value": "coffee",
"meta": "3"
},
{
"tokenType": 3
},
{
"tokenType": 0,
"value": "tea"
}
]
],
"excludes": [
{
"tokenType": 0,
"value": "lemonade"
}
],
"andContains": [
{
"tokenType": 0,
"value": "cranberry"
},
{
"tokenType": 0,
"value": "water"
}
]
}
],
"meta" : {
"totalCount" : 1
}
}
*title* - string value indicating the name of the keyword group

*type* - integer value indicating the type of the keyword group
*active* - boolean value indicating whether the keyword group remains active in the account
*contains* - array of filters that include contplex filter queries with operators AND and
NOT:
*tokenType* - integer value indicating types of keyword tokens:
*0* - KEYWORD_OR_PHRASE (requires tokenType and value information)
*1* - PROXIMITY (requires tokenType, value, and meta information)
*2* - AND (requires only tokenType value)
*3* - NOT (requires only tokenType value)
*value* - string value indicating keyword or phrase to include in search
*meta* - integer value in range of -1 to 20 indicating proximity of key terms to trigger
inclusion
*andContains* - array of values indicating other keywords to include in results (no operators
141
Keyword Groups Create Keyword Groups
allowed)
*excludes* - array of values indicating other keywords to exclude from results (no operators
allowed, cannot exceed the maximum number set at the client level)
Create Keyword Groups

This method creates a new keyword group not associated with a topic profile.
/v3/keywordGroups
HTTP Method
POST
Request Parameters
None

GET /v3/keywordGroups
JSON Parameters
Each JSON payload includes the following arguments:

NOT:
inclusion
allowed)
142
Keyword Groups Create Keyword Groups

Your keywords cannot accept predefined stop works, including the following values:
a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,1,2,3,4,5,6,7,8,9,0,!,@,#,$,^,*,(,),am,an,as,at,be,by,do,go,he,if,in,is,it,me,my,no,of,on,or,so,to,up,us,we,and,the,for,not,she,was,test
Your keywords cannot accept any invalid characters, including the following values:
^"<>|*\n
The overall number of keywords and phrases for the topic profile cannot exceed the maximum number set at the client level. Contact
your administrator to determine these levels.
Sample Request
curl -X POST -H "Content-Type: application/json" -H "Accept: application/json"-H
"access_token: your_access_token" -d "{
\"title\" : \"Presidential Test\",
\"type\" : 2,
\"active\" : true,
\"contains\" : [
[
{
\"tokenType\" : 1,
\"value\" : \"President\",
\"meta\" : \"2\"
}
]
]
}" "https://{host}/v3/keywordGroups"
Sample Response
{
"data": [
{
"id": "408299"
}
],
"meta":
{
"totalCount": 1
143
Keyword Groups Update Keyword Groups
}
}
*data* - array of returned information from the call

*id* - integer value indicating the unique ID for the created keyword group
A call with a malformed JSON document returns a 400 error. Ensure you correctly formatted your JSON information.
Update Keyword Groups

This method creates a new keyword group not associated with a topic profile.
/v3/keywordGroups/{id}
HTTP Method
PUT
Request Parameters
*id* - integer value indicting unique ID for keyword group

PUT /v3/keywordGroups
JSON Parameters
Each JSON payload includes the following arguments:

NOT:
inclusion
144
Keyword Groups Update Keyword Groups
allowed)
Your keywords cannot accept predefined stop works, including the following values:
a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,1,2,3,4,5,6,7,8,9,0,!,@,#,$,^,*,(,),am,an,as,at,be,by,do,go,he,if,in,is,it,me,my,no,of,on,or,so,to,up,us,we,and,the,for,not,she,was,test
Your keywords cannot accept any invalid characters, including the following values:
^"<>|*\n
The overall number of keywords and phrases for the topic profile cannot exceed the maximum number set at the client level. Contact
your administrator to determine these levels.
Sample Request
curl -X PUT -H "Content-Type: application/json" -H "Accept: application/json"-H
"access_token: your_access_token" -d "{
\"title\": \"Presidential Test\",
\"active\": true,
\"type\": 2,
\"keywordsCount\": 0,
\"contains\": [
[
{
\"tokenType\": 1,
\"value\": \"President\",
\"meta\": \"2\"
}
]
],
\"andContains\": [],
\"excludes\": []
}" "https://{host}/v3/keywordGroups/408299"
Sample Response
A call with a malformed JSON document returns a 400 error. Ensure you correctly formatted your JSON information.
A call from a user with insufficient permissions to perform the update returns a 403 call. Contact your administrator for the proper
permissions.
145
CHAPTER 15 Sources and Source Groups
In this chapter ... Use sources to identify specific Facebook pages, Twitter accounts, blog posts, and other source types.
These source types can further refine the topic profile definition. You can also combine sources into
Retrieve Sources groups.
Retrieve Source
Create Source
Update Source
Retrieve Sources
Delete Source
GET /v3/sourceFilters/1055/sourceFilterQueries
Retrieve Source
Groups
Retrieve Source cURL Example
Group
Create Source Group
Update Source
Group -H "Content-Type:
Delete Source Group application/json"'https://api.socialstudio.radian6.com/v3/sourceFilters/1055/sourceFilterQueries'
146
Sources and Source Groups Retrieve Sources
Retrieve Sources
This method returns all source filter queries associated with a social filter.
/v3/sourceFilters/{sourceFilterId}/sourceFilterQueries
HTTP Method
GET
Request Parameters
*sourceFilterId* - integer value indicating the source filter from which to retrieve a
social filter query (required)
Query Parameters

*orderBy* - string values indicating how call sorts returned list of source filters:
*id* - sort by ID value
*title* - sort by title
*uri* - sort by URI

GET /v3/sourceFilters{id}/sourceFilterQueries
Sample Request
GET /v3/sourceFilters/1/sourceFilterQueries
Sample Response
{
"data": [
{
"id": "1",
"title": "Source Filter Query Title",
"uri": "my.source.filter.query.org"
}
],
"meta": {
147
Sources and Source Groups Retrieve Source
"totalCount": 1
}
}
*id* - integer value indicating unique identifier for source filter

*title* - string value indicating name for source filter
*uri* - string value including source filter query location in system
Retrieve Source
This method returns a specified source filter query associated with a social filter.
/v3/sourceFilters/{sourceFilterId}/sourceFilterQueries/{sourceFilterQueryId}
HTTP Method
GET
Request Parameters
*sourceFilterQueryId* - integer value indicating the source filter query to retrieve
(required)
Query Parameters

*orderBy* - string values indicating how call sorts returned list of source filters:
*uri* - sort by URI

GET /v3/sourceFilters/{sourceFilterId}/sourceFilterQueries/{sourceFilterQueryId}
Sample Request
GET /v3/sourceFilters/1/sourceFilterQueries/123
148
Sources and Source Groups Create Source
Sample Response
{
"data": [
{
"id": "123",
"title": "Source Filter Query Title",
"uri": "my.source.filter.query.org"
}],
"meta": {
"totalCount": 1
}
}
*id* - integer value indicating unique identifier for source filter

*uri* - string value including source filter query location in system
Create Source
This method creates a source filter query within an account. You can add this source filter query to the source filter to create conditions
for use within the filter.
/v3/sourceFilters/{sourceFilterId}/sourceFilterQuery
HTTP Method
POST
Request Parameters

POST /v3/sourceFilters/{sourceFilterId}/sourceFilterQuery
JSON Parameters

*uri* - string value indicating location for source filter query(required)
149
Sources and Source Groups Update Source
Sample Request
POST /v3/sourceFilters/1/sourceFilterQuery
{
"title": "Source Filter Title",
"uri": "A description of what this source filter contains."
}
Sample Response
A successful call returns a 201 Success response. A Location response header contains the URL to the new source filter query resource.
A malformed JSON payload returns a 400 Bad Request response. Ensure your payload matches the sample shown in this example.
Update Source
This method updates a source filter query within an account.
HTTP Method
PUT
Request Parameters
(required)

PUT /v3/sourceFilters/{sourceFilterId}/sourceFilterQueries/{sourceFilterQueryId}
JSON Parameters

*uri* - string value indicating location for source filter query(required)
150
Sources and Source Groups Delete Source
Sample Request
PUT /v3/sourceFilters/1
{
"title": "Source Filter Title",
"uri": "A description of what this source filter contains."
}
Sample Response
A successful call returns a 204 No Content response, indicating the call successfully updated the source filter.
Delete Source
This method deletes the source filter query specified by the ID. This action removes the souce query filter from any associated source
filter.
HTTP Method
DELETE
Request Parameters
(required)

DELETE /v3/sourceFilters/{sourceFilterId}/sourceFilterQueries/{sourceFilterQueryId}
Sample Request
DELETE /v3/sourceFilters/1/socialFilterQueries/123
Sample Response
A successful call returns a No Content 204 code, indicating the call succeded and no content exists.
151
Sources and Source Groups Retrieve Source Groups
An internal error occuring during the call returns a 500 error.
Retrieve Source Groups

This method returns all source groups available to the authenticated users.
/v3/sourceFilters
HTTP Method
GET
Request Parameters

*title* - string value including characters to search for an exact title match
*status* - string value including comma-separated list of status values to search:
*0* - deactivated source groups
*2* - active source groups
*3* - draft source groups
*orderBy* - string values indicating how call sorts returned list of source groups:
*visibility* - sort by visibility
*status* - sort by status
*creation* - sort by creation date
*description* - sort by description
*creator* - sort by creator display name
*ASC* - sort in ascending order
*DESC* - sort in descending order

GET /v3/sourceFilters
Sample Request
GET /v3/sourceFilters?status=2
Sample Response
{
data: [
{
152
Sources and Source Groups Retrieve Source Group
id: 1,
title: Trent - Yahoo Answers SF,
description: null,
status: 2,
createdDate: 20091222T17:22:08Z,
topicCount: 0,
public: false,
creator: {
id: 58,
link: https://api.radian6.com/socialcloud/v2/users/58,
updated: null,
title: Trent - Staging - GMail - CLID = 1
}
},

],
meta: {
totalCount: 706
}
}
*id* - integer value indicating unique identifier for source group

*title* - string value indicating name for source group
*description* - string value including text describing source group
*status* - integer value indicating status of source group
*createdDate* - timestamp value indicating date of creation for source group
*topicCount* - integer value indicating topics associated with source group
*public* - boolean value indicating whether the source group can be viewed publicly
*creator* - object including information on user who created the source group
*id* - integer value indicating unique identifier for user
*link* - string value including URL for user
*updated* - timestamp value indicating last time user updated their information (can
be null)
*title* - string value indicating name of user
Retrieve Source Group

This method returns a source group specified by the ID value.
/v3/sourceFilters/{sourceFilterId}
HTTP Method
GET
Request Parameters
*sourceFilterId* - integer value indicating ID for source group
153
Sources and Source Groups Retrieve Source Group

GET /v3/sourceFilters/{sourceFilterId}
Sample Request
GET /v3/sourceFilters/1
Sample Response
{
data: [
{
id: 1,
title: Trent - Yahoo Answers SF,
description: null,
status: 2,
createdDate: 20091222T17:22:08Z,
topicCount: 0,
public: false,
creator: {
id: 58,
link: https://api.radian6.com/socialcloud/v2/users/58,
updated: null,
title: Trent - Staging - GMail - CLID = 1
}
},
],
meta: {
totalCount: 1
}
}
*id* - integer value indicating unique identifier for source group

*title* - string value indicating name for source group
*description* - string value including text describing source group
*status* - integer value indicating status of source group
*createdDate* - timestamp value indicating date of creation for source group
*topicCount* - integer value indicating topics associated with source group
*public* - boolean value indicating whether the source group can be viewed publicly
*creator* - object including information on user who created the source group
*id* - integer value indicating unique identifier for user
*link* - string value including URL for user
*updated* - timestamp value indicating last time user updated their information (can
be null)
*title* - string value indicating name of user
154
Sources and Source Groups Create Source Group
Create Source Group

This method creates a source group within an account. You can then add sources to the source group and create conditions for use
within the topic profile.
/v3/sourceFilters
HTTP Method
POST
Request Parameters
None

POST /v3/sourceFilters
JSON Parameters
*title* - string value indicating name for source group (create)

*description* - string value including text describing source group (create)
*public* - boolean value indicating whether the source group includes a public status
Sample Request
POST /v3/sourceFilters/
{
"title": "source group title",
"description": "A description of what this source group contains.",
"public": false
}
Sample Response
A successful call returns a 201 Success response. A Location response header contains the URL to the new source group resource.
155
Sources and Source Groups Update Source Group
Update Source Group

This method updates a source group available to an authenticated user.
HTTP Method
PUT
Request Parameters
*sourceFilterID* - The ID for the specific source group you wish to update

PUT /v3/sourceFilters/{sourceFilterID}
JSON Parameters
*title* - string value indicating name for source group (required)

*description* - string value including text describing source group (required)
*public* - boolean value indicating whether the source group includes a public status
Sample Request
PUT /v3/sourceFilters/1
{
"title": "source group Title",
"description": "A description of what this source group contains.",
"public": false
}
Sample Response
A successful call returns a 204 No Content response, indicating the call successfully updated the source group.
156
Sources and Source Groups Delete Source Group
Delete Source Group

This method deletes the source group specified by the ID.
HTTP Method
DELETE
Request Parameters
*sourceFilterId* - integer value indicating ID for source group

DELETE /v3/sourceFilters/{sourceFilterId}
Sample Request
DELETE /v3/sourceFilters/1
Sample Response
A successful call returns a No Content 204 code, indicating the call succeeded and no content exists.
An internal error occurring during the call returns a 500 error.
157
CHAPTER 16 Languages
In this chapter ...
Retrieve Languages
Retrieve Language
158
Languages Retrieve Languages
Retrieve Languages
This method retrieves information about all languages available when managing your topic profile.
/v3/languages
HTTP Method
GET
Request Parameters
*limit* - integer value indicating number of results to return (defaults to 1000). This
method does not return any deleted comments.

GET /v3/languages
Sample Request
GET /v3/languages
cURL Example
'https://api.socialstudio.radian6.com/v3/languages'
Sample Response
{
"data": [
{
"id": "1",
"title": "English",
"code": "en"
},
{
"id": "2",
"title": "French",
"code": "fr"
},
{
159
Languages Retrieve Language
"id": "3",
"title": "Spanish",
"code": "es"
},
...
],
"meta": {
"totalCount": 28
}
}
*id* - integer value identifying the language

*title* - string value containing the English-language name for the language
*code* - string value containing the ISO language code for the language
Retrieve Language
This method retreives information about all languages available within an account.
/v3/languages/{id}
HTTP Method
GET
Request Parameters
*id* - integer value indicating the language to retrieve

GET /v3/languages/{id}
Sample Request
GET /v3/languages/1
Sample Response
{
"data": [
{
"id": "1",
160
Languages Retrieve Language
"title": "English",
"code": "en"
},
],
"meta": {
"totalCount": 1
}
}
*id* - integer value identifying the language

*title* - string value containing the English-language name for the language
*code* - string value containing the ISO language code for the language
161
CHAPTER 17 Regions
In this chapter ...
Retrieve Regions
Retrieve Region
162
Regions Retrieve Regions
Retrieve Regions
This method retrieves information about all regions available when managing your topic profile.
/v3/regions
HTTP Method
GET
Request Parameters


GET /v3/regions
Sample Call
GET /v3/regions
cURL Example
curl -X GET -H "access_token: 513e6576-218d-4a9e-b7cc-ac4ebf45fd1e" -H "Content-Type:
application/json" 'https://api.socialstudio.radian6.com/v3/regions'
Sample Response
{
"data": [
{
"id": "46",
"title": "China",
"regionTLD": ".cn",
"isoCountryCode": "CN"
},
{
"id": "78",
"title": "French Southern Territories",
"regionTLD": ".tf",
"isoCountryCode": "TF"
},
{
163
Regions Retrieve Region
"id": "158",
"title": "New Caledonia",
"regionTLD": ".nc",
"isoCountryCode": "NC"
},
...
],
"meta": {
"totalCount": 249
}
}
*id* - integer value indicating internal ID for region

*title* - string value including English name for region
*regionTLD* - string value including top-level domain for region
*isoCountryCode* - string value including ISO country code
Retrieve Region
This method returns a specific region associated with an account.
/v3/regions/{regionId}
HTTP Method
GET
Request Parameters
*regionId* - integer value indicating internal ID for region

GET /v3/regions/{regionId}
Sample Call
GET /v3/regions/46
Sample Response
{
"data": [
{
164
Regions Retrieve Region
"id": "46",
"title": "China",
"regionTLD": ".cn",
"isoCountryCode": "CN"
}
],
"meta": {
"totalCount": 1
}
}
*id* - integer value indicating internal ID for region

*title* - string value including English name for region
*regionTLD* - string value including top-level domain for region
*isoCountryCode* - string value including ISO country code
165
CHAPTER 18 Media Types
In this chapter ...
Retrieve Media Types
Retrieve Media Type
166
Media Types Retrieve Media Types
Retrieve Media Types

This method retrieves a collection of media types on supplied parameters.
/v3/mediaTypes
HTTP Method
GET
Request Parameters
None

GET /v3/mediaTypes
Query Parameters
*private* - boolean value indicating a return of only private media types (defaults to
false)
*classificationIds* - string value containing comma-delimited list of media type
classification IDs. This parameter returns media types belonging to the specified
classifications. When supplying this value, call will ignore *private* parameter and return
all results associated with supplied classification IDs.
*offset* - integer value indicating result to start with in returned results
Sample Request
GET /v3/mediaTypes?private=true&classificationIds=1,3
cURL Example
'https://api.socialstudio.radian6.com/v3/mediaTypes'
Sample Response
{
"data": [
{
"id": "1",
167
Media Types Retrieve Media Type
"title": "Blogs",
"isVisible": true,
"classificationId": "1",
"classificationType": "Broad Listening"
},
{
"id": "2",
"title": "Videos",
"isVisible": true,
},
...
],
"meta": {
"totalCount": 12
}
}
*id* - integer value indicating unique identifier of media type

*title* - string value indicating description of media type
*isVisible* - boolean value indicating visibility of media type in account
*classificationId* - integer value indicating unique identifier of media type classification
*classificationType* - string value indicating description of media type classification
Retrieve Media Type

This method retrieves a single media types based on the supplied ID.
/v3/mediaTypes/{id}
HTTP Method
GET
Request Parameters
*mediaTypeId* - integer value indicating media type to retrieve

GET /v3/mediaTypes/{id}
Sample Request
GET /v3/mediaTypes/1
168
Media Types Retrieve Media Type
Sample Response
{
"data": [
{
"id": "1",
"title": "Blogs",
"isVisible": true,
}
],
"meta": {
"totalCount": 1
}
}
*id* - integer value indicating unique identifier of media type

*title* - string value indicating description of media type
*isVisible* - boolean value indicating visibility of media type in account
*classificationId* - integer value indicating unique identifier of media type classification
*classificationType* - string value indicating description of media type classification
169
CHAPTER 19 Posts
In this chapter ... Use the Post endpoint to retrieve the social post content associated with a predefined topic profile. The
Social Studio API allows an export of up to 1000 posts per topic profile every 30 seconds (equaling 2.8
Retrieve Posts million posts in 24 hours).
The Social Studio API enforces some content restruction due to legal requirements:
The API removes all Twitter content and can only provide post and author IDs as well as workflow data for
each post. We remove tweet content and post dynamics you can rehydrate directly via Twitter APIs *We
truncate any broad listening topic profile content to 310 characters or 10 percent of the content, whichever
is greater.
Retrieve Posts
GET /v3/posts
cURL Example
'https://api.socialstudio.radian6.com/v3/posts?topics=1829'
170
Posts Retrieve Posts
Retrieve Posts
This method retrieves post data from available broad listening topic profiles and social accounts.
/v3/posts
HTTP Method
GET
Request Parameters
None

GET /v3/posts
Query Parameters
*topics* - string value containing comma-delimited list of topic profile IDs to include
in call (required)
*limit* - integer value indicating number of posts to return in the call (defaults to 25,
accepts values from 1 to 1000)
*sinceId* - integer value indicating ID of post to start retrieve. This parameter allows
only posts created after the identified post.
*beforeId* - integer value indicating ID of post to start retrieve. This parameter allows
only posts created before and including the identified post.
*startDate* - timestamp value indicating the the start date for the filter. This parameter
allows only those posts published to the social media channel on or after the given date,
based on the *updated* attribute for the post (defaults to 24 hours before call occurs).
*endDate* - timestamp value indicating the the end date for the filter. This parameter
allows only those posts published to the social media channel on or before the given date,
based on the *updated* attribute for the post (defaults to current time).
*mediaTypes* - string value containing comma-delimited list of media type IDs to include
in call (defaults to all applicable media types including in the specified topic profiles)
*extendedMediaTypes* - string value containing comma-delimited list of extended media type
IDs to include in call (defaults to all applicable extended media types including in the
specified topic profiles)
*includeWorkflow* - boolean value indicates whether to include workflow with the returned
posts (defaults to false)
*includeSpam* - boolean value indicating whether to include posts flagged as spam by the
Salesforce Marketing Cloud (defaults to false)
*includeAnchors* - boolean value indicating whether to include anchor tags in content. A
*true* value indicates the call returns links as HTML anchor tags within the returned post
content. A *false* value returns plain text (defaults to false).
*highlight* - boolean value indicating whether the call highlights keywords. A *true* value
indicating highlighted keywords from the topic profile configuration in the post content
171
for use when presented in a web page. A *false* value returns plain text (defaults to
false).
*keywords* - string value containing a comma-delimited list of keywords to use when returning
only posts containing those values. This parameter includes up to 50 values and ignores
duplicates.
*sortBy* - string values indicating how call sorts the response:
*publishedDate* - sort by published date in descending order
*publishedDate-ascending* - sort by published date in ascending order
*blogPostId* - sort by post object ID in descending order (default)
*blogPostId-ascending* - sort by post object ID in ascending order
*rankBM25* - sort by relevance rank based on matched keywork frequency
*keywordGroups* - string value containing comma-delimited list of filter group IDs used
to filter posts associated only with those groups. Defaults to all keyword groups provided
in topic profiles from the *topics* parameter.
*includeSourceFilterMatches* - boolean value indicating whether to include the source
groups containing URLs each post matches (defaults to false)
*regions* - string value containing comma-delimited list of region IDs (defaults to all
regions assigned to topics from the *topic parameter)
*languages* - string value containing comma-delimited list of language IDs (defaults to
all languages assigned to topics from the *topic parameter)
*assignedUser* - string value including a comma-delimited list of users IDs for users
within the same client as the calling user
*engagement* - string value containing comma-delimited list of engagement status IDs to
return
*priority* - integer value indicating priority values to use when returning posts:
*1* - low
*2* - medium
*3* - high
*classification* - string value containing comma-delimited list of classifications to
return
*eventsSince* - timestamp value used to indicate posts to return after provided value
(milliseconds after midnight on 1/1/1970). Adding this parameter includes an HTTP header
called Workflow-As-Of-Date that contains current timestamp of call. Use this value to
retrieve only workflow events applied since previous method call. This parameter considers
only workflow applied within last 30 days of call.
*unassigned* - boolean value indicating the call returns only unassigned posts
*sentiment* - string value containing comma-delimited list of sentiment IDs used to filter
posts:
*-10* - Negative
*0* - Neutral
*10* - Positive
*authorTags* - string value containing comma-delimited list of author tags used to filter
posts
Sample Call
The call below returns posts from the specified topic profile:
GET /v3/posts?topics=1234
The call below returns the latest 50 Twitter posts:

GET /v3/posts?topics=1234&mediaTypes=8&limit=50
172
The call below returns the latest 50 Twitter posts since the specified ID
GET /v3/posts?topics=1234&mediaTypes=8&limit=50&sinceId=777777
Sample Response
{
"data" : [
{
"id": "1828477438",
"title": "Tennis Star visits Malawi",
"externalId": null,
"externalLink": "http://www.youtube.com/watch?v=exampleValue",
"sourceApplication": null,
"content": "",
"summaryContent": "",
"publishedDate": "2015-07-21T10:07:58Z",
"harvestDate": "2015-07-21T11:23:23Z",
"languageId": 1,
"regionId": 249,
"postStatus": 0,
"mediaProvider": {
"id": "2",
"title": "YouTube",
"mediaTypeId": 2,
"extendedMediaType": null
},
"source": {
"id": "2229562169",
"title": "Tennis Star visits Malawi",
"externalLink": "youtube.com",
"language": "en",
"region": null,
"tags": [
{
"id": "7494",
"value": "Sample source tag"
}
],
"comments": [
{
"id": "56436",
"value": "Sample source comment",
"noteTypeId": "4"
}
]
},
"author": {
"id": "-1",
"title": "YouTube Channel",
"externalId": "-1",
"externalLegacyId": null,
"authorFullName": "YouTube Channel",
"avatar": null,
173
"authorTags": [
{
"id": "5567567",
"value": "Sample author tag"
}
],
"authorComments": [
{
"id": "556456456",
"value": "Sample author comment"
}
],
"bio": null,
"verified": false
},
"parent": null,
"sentiment": null,
"postStatusException": null,
"engagement": 4564,
"classification": 4,
"tags": [
{
"id": "5466546",
"value": "Sample tag"
}
],
"postDynamics": [
{
"fieldId": "5",
"label": "View Count",
"value": "0"
},
{
"fieldId": "1",
"label": "Comment Count",
"value": "0"
},
{
"fieldId": "2",
"label": "Unique Commenters",
"value": "0"
},
{
"fieldId": "3",
"label": "Engagement",
"value": "0"
},
{
"fieldId": "4",
"label": "Likes and Votes",
"value": "0"
},
{
"fieldId": "7",
174
"label": "Inbound Links",

"value": "0"
},
{
"fieldId": "21",
"label": "Sentiment",
"value": "0",
"overridden": "false"
}
],
"metadata": null,
"topics": [
4526
],
"sourceFilterMatches": null,
"assignedUser": null,
"comments": [
{
"id": "435345",
"value": "Sample comment",
"noteTypeId": "0"
}
]
}
}
],
"meta" : {
"totalCount" : 1
}
}
*id* - integer value indicating unique identifier for post object, used to assign and
access workflow associated with post
*title* - string value containing description of post
*externalId* - integer value indicating unique ID for post assigned by original social
media channel (such as Facebook or Twitter)
*externalLink* - string value containing URL of original post
*sourceApplication* - string value for name of application that created Twitter content
*content* - string value containing text of original post, including links
*summaryContent* - string value reserved for internal use (will always return empty)
*harvestDate* - timestamp value indicating when Social Studio discovered and indexed post
*languageId* - integer value indicating supported language for post (review Languages route
for available IDs)
*regionId* - integer value indicating region associated with post (review region route for
available IDs)
*postStatus* - integer value indicating post status:
*0* - normal, active post
*1* - spam (auto-detected)
*2* - deleted or hidden post (based on user action)
*sentiment* - integer value indicating manually assigned sentiment value (requires
includeWorkflow=true)
*postStatusException* - integer value indicating manually assigned post status value
(requires includeWorkflow=true)
175
*engagement* - integer value indicating state(such as under review or closed) of post

*classification* - integer value indicating classification group assigned to post (requires
*assignedUser* - integer value indicating user assigned to post (requires
*priority* - integer value indicating priority assigned to post (requires
*tags* - array of tag values attached to post (requires includeWorkflow=true)
*comments* - array of comment values attached to post (requires includeWorkflow=true)
*mediaProvider* - object containing information about post within context of original
social network:
*id* - integer value indicating original social network
*title* - string value indicating name of original social network
*mediaTypeId* - number value indicating type of media
*extendedMediaType* - number value indicating type of extended media
*source* - object containing information about post source used to represent source in
Social Studio. Multiple posts may use the same source. Requires includeWorkflow=true.
*id* - integer value indicating unique identifier of source
*title* - string value containing text describing post
*externalLink* - string value containing link to original post
*language* - string value containing ISO language code
*region* - string value containing region associated with post
*tags* - array of string values indicating tags for post
*verified* - boolean value indicating whether Twitter verified post
*author* - object containing information about individual or company that created post
*id* - integer value indicating unique identifier for author
*title* - string value containing text describing author
*externalId* - integer value indicating unique identifier for author on social media
channel
*externalLegacyId* - integer value indicating unique legacy identifier for author on
social media channel
*authorFullName* - string value containing full name for author
*avatar* - string value containing location for avatar image file
*authorTags* - array containing ID and value pairs for tags attached to author
*authorComments* - array containing ID and value pairs for comments attached to author
*bio* - string value containing author bio information

*verified* - boolean value indicating whether Twitter verified author
*parent* - object containing IDs used by Social Studio and the social media channel to
identify parent post
*postDynamics* - object containing more information about the post (such as number of likes
or comments for a post). These numbers change over time and vary from social channel to
social channel.
*metadata* - object containing additional metadata about the post. This information can
change over time and vary from social channel to social channel.
*topics* - object containing information about the topics associated with the post (topics
assigned in request parameter)
*sourceFilterMatches* - object containing the source group with URLs the post matches
*parentAuthor* - object containing information on author of parent post for current post.
Currently used only for retweeted Twitter posts.
176
CHAPTER 20 Engage Macros
In this chapter ... This endpoint allows you to configure predefined metadata to automatically apply when performing a
workflow on posts in Engage and Analyze scenarios. For example, you might want to apply a macro
Retrieve Macros whenever you see a social post that mentions the brand in the following manner:
Retrieve Macro
@Brand, my laptop just crashed! Need help asap!
Create Macro
Update Macro The macro would execute the following actions:
Execute Macro *Add a post tag *Laptop*
Delete Macro *Set priority as *High*
*Send to Salesforce as a case
Retrieve
SalesforceOrgs
Retrieve
SalesforceOrg
Create Macro
First, create a macro to define workflow tasks to execute:
POST /v3/macros
cURL Example
curl -X POST -H "access_token: 82200099-7799-4023-b76d-11bb7c941bf1"
"name": "Urgent - Laptop Support Issue",
"description": "Urgent Laptop Issues to be addressed ASAP",
"actions": [
{
"type": "SetPriority",
"value": "3"
},
{
"type": "AddPostNote",
"value": "Laptop"
},
{
"type": "SendToSalesforceScs",
"value": "00DD00000007aAJMAY",
"parameters": [
{
"name": "case",
"value": "on"
},
177
Engage Macros
{
"name": "lead",
"value": "off"
}
]
}
]
}' 'https://api.socialstudio.radian6.com/v3/macros'
Apply Macro
Once you create a macro, you can apply it to a post:
POST /v3/macros/{id}?action=execute
cURL Example
curl -X POST -H "Content-Type: application/json" -H "access_token:
82200099-7799-4023-b76d-11bb7c941bf1" -d '{
"posts" : [1868932796],
"topics" : [8]
}'
'https://api.socialstudio.radian6.com/v3/macros/23114?action=execute'
178
Engage Macros Retrieve Macros
Retrieve Macros
This method retrieves all macros within a Social Studio organization. This macro can contain several different actions within the JSON
payload, indicating actions to perform when the macro receives an execute call. Use the Salesforce Organzation methods to retrieve
necessary Service Cloud values for this call.
/v3/macros
HTTP Method
GET
Query Parameters
*workspaceGroupID* - reserved for internal use

*workspaceId* - integer value indicating return of only those macros from the specified
workspace

GET /v3/macros
Sample Request
GET /v3/macros
Sample Response
A successful call returns the following response (can be an array of macros:
"data": [
{
"id": 322,
"name": "Forward to Salesforce",
"description": "Sends post for further investigation",
"owner": {
"id": "1827",
"title": "John.Smith@domain.com",
"avatarURL": null
},
"client": 1,
"createdDate": "2014-03-26T16:04:29Z",
"modifiedDate": null,
"actions": [
{
"value": "00DR00000008ioUFGY",
179
Engage Macros Retrieve Macros
"parameters": [
{
"name": "case",
"value": "on"
},
{
"name": "lead",
"value": "on"
}
]
}
]
}
],
"meta": {
"totalCount": 1
}
}
*id* - integer value indicating unique ID for macro

*name* - string value indicating name for macro
*description* - string value including text describing the macro
*owner* - integer value indicating unique ID for owner of macro
*client* - integer value indicating unique ID for client containing macro (read-only)
*createdDate* - timestamp value indicating when system created macro (read-only)
*modifiedDate* - timestamp value indicating when system last updated macro (read-only)
*action* - array of actions included within macro:
*SetClassification* - integer value indicating media type classification to add
*AddAuthorTag* - string value to add as tag to author object
*AddPostTag* - string value to add as tag to post object
*AssignUser* - integer value identifying post to assign to user
*SetEngagement* - integer value identifying engagement level to set
*SetPriority* - integer value identifying priority level to set
*AddPostNote* - string value to add to post as note
*SetSpamStatus* - integer value used to set spam status
*0* - not spam
*2* - spam
*AddSourceTag* - string value to add as source tag
*SetSentiment* - integer value to set as sentiment level
*SendToSalesforceScs* - integer value used to set organization to which the macro will
send post
*case* - string value indicating whether to create case
*off* - do not create case
*on* - create case (default)
*lead* - string value indicating whether to create lead
*off* - do not create lead (default)
*on* - create lead
180
Engage Macros Retrieve Macro
Retrieve Macro
This method retrieves a macro within a Social Studio organization. This macro can contain several different actions within the JSON
Resource
/v3/macros/{id}
HTTP Method
GET
Request Parameters
*id* - integer value indicating

GET /v3/macros{id}
Sample Request
GET /v3/macros/1234
Sample Response
A successful call returns the following response (can be an array of macros:
"data": [
{
"id": 322,
"name": "Forward to Salesforce",
"description": "Sends post for further investigation",
"owner": {
"id": "1827",
"title": "John.Smith@domain.com",
"avatarURL": null
},
"client": 1,
"createdDate": "2014-03-26T16:04:29Z",
"modifiedDate": null,
"actions": [
{
181
Engage Macros Retrieve Macro
"value": "00DR00000008ioUFGY",
"parameters": [
{
"name": "case",
"value": "on"
},
{
"name": "lead",
"value": "on"
}
]
}
]
}
],
"meta": {
"totalCount": 1
}
}

*name* - string value indicating name for macro
*0* - not spam
*2* - spam
send post
*on* - create lead
182
Engage Macros Create Macro
Create Macro
This method creates a macro within a Social Studio organization. This macro can contain several different actions within the JSON payload,
indicating actions to perform when the macro receives an execute call. Use the Salesforce Organzation methods to retrieve necessary
Service Cloud values for this call.
Resource
/v3/macros
HTTP Method
POST
Request Parameters
None

POST /v3/macros
JSON Parameters
*name* - string value indicating name for macro (required)

*0* - not spam
*2* - spam
send post
183
Engage Macros Update Macro

*on* - create lead
Sample Request
POST /v3/macros
{
"name" : "Add post tag",
"description" : "Adds a tag to a post",
"actions": [
{
"type": "AddPostTag",
"value": "Post Tag"
}
]
}
Sample Response
{
"data": [
{
"id": "23719"
}
],
"meta": {
"totalCount": 1
}
}

Update Macro
This method updates a macro within a Social Studio organization. This macro can contain several different actions within the JSON
Resource
/v3/macros/{id}
184
Engage Macros Update Macro
HTTP Method
PUT
Request Parameters

PUT /v3/macros
JSON Parameters
*name* - string value indicating name for macro (required)

*actions* - array of actions included within macros:
*0* - not spam
*2* - spam
send post
*on* - create lead
Sample Request
PUT /v3/macros/1234
{
"name": "My Macro",
"description": "Macro Description",
"actions": [
{
185
Engage Macros Execute Macro
"type": "AddPostTag",
"value": "Post Tag"
}
]
}
Sample Response
A successful call returns HTTP 200
Execute Macro
This method executes a macro within a Social Studio organization. Use the Salesforce Organzation methods to retrieve necessary Service
Cloud values for this call.
Resource
/v3/macros/{id}
HTTP Method
POST
Request Parameters
Query Parameters
*action* - string value indicating action to perform

*execute*
JSON Parameters
*posts* - array of integer values identifying posts included in the running macro
*topics* - array of integer values identifying topics included in the running macro

POST /v3/macros/{id}
186
Engage Macros Delete Macro
Sample Request
POST /v3/macros/{id}?action=execute
{
"posts": [2345],
"topics" : [8]
}
Sample Reponse
{
"results": [
{
"postId": <2345>,
"action": "AddPostTag",
"result": "SUCCESS",
"error": ""
}
]
}
*results* - object including data on macro execution

*postId* - integer value indicating post on which macro performed
*0* - not spam
*2* - spam
send post
*on* - create lead
Delete Macro
This method deletes a macro within a Social Studio organization. Use the Salesforce Organzation methods to retrieve necessary Service
Cloud values for this call.
187
Engage Macros Retrieve SalesforceOrgs
Resource
/v3/macros/{id}
HTTP Method
DELETE
Request Parameters

DELETE /v3/macros/{id}
Sample Request
DELETE /v3/macros/{id}
Sample Reponse
A successful call returns a No Content 204 code, indicating the call succeeded and no content exists.
A call that matches no macro ID value returns a 404 Not Found code.
Retrieve SalesforceOrgs
This method returns information on all Salesforce organizations registered within the tenant for the user executing the call.
/v3/salesforceOrganizations
HTTP Method
GET
Request Parameters
None
188
Engage Macros Retrieve SalesforceOrg

GET /v3/salesforceOrganizations
Sample Request
GET /v3/salesforceOrganizations
Sample Request
{
"data": [
{
"id": "00D61000000YMhPABC",
"title": "prod.r64sf",
"isSCS": false,
"isSandbox": false,
"isPersonAccountCapable": false,
"adminEmail": "john.doe@salesforce.com",
"integrationUserId": 6110,
"tenantId": 1
}],
"meta" : {
"totalCount" : 1
}
}
*id* - string value containing the 18-character unique ID for the Salesforce organization
*link* - string value containing the URL location for the organization
*updated* - timestamp value indicating when the last organization update occured
*title* - string value indicating the name of the organization
*isSCS* - boolean value indicating whether the organization uses the Social Cloud
*isSandbox* - boolean value indicating whether the organization functions as a developer
sandbox
*isPersonAccountCapable* - boolean value indicating whether the organization can use person
accounts
*adminEmail* - string value including the email address for the organization administrator
*integrationUserId* - integer value indicating the unique ID for the organization integration
user
*tenantId* - integer value indicating the unique ID for the tenant associated with the
Salesforce organization
Retrieve SalesforceOrg
This method returns information on a specified Salesforce organization registered within the tenant for the user executing the call.
/v3/salesforceOrganizations/{id}
189
HTTP Method
GET
Request Parameters
(required)

GET /v3/salesforceOrganizations/{id}
Sample Request
GET /v3/salesforceOrganizations/00DA00000000000001
Sample Request
{
"id": "00DA00000000000001",
"link":
"https://stg3-api.dev.ca1.sfmc.co/socialcloud/v3/salesforceOrganizations/00DA00000000000001
",
"updated": "2015-01-01T00:00:00Z",
"title": "Organization Name",
"isSCS": true,
"isSandbox": false,
"isPersonAccountCapable": false,
"adminEmail": "orgowner@example.com",
"integrationUserId": 10010010,
"tenantId": 1
}
*link* - string value containing the URL location for the organization
*updated* - timestamp value indicating when the last organization update occured
*title* - string value indicating the name of the organization
*isSCS* - boolean value indicating whether the organization connects to the Service Cloud
via Social Customer Service integration
*isSandbox* - boolean value indicating whether the organization functions as a developer
sandbox
*isPersonAccountCapable* - boolean value indicating whether the organization can use person
accounts
*adminEmail* - string value including the email address for the organization administrator
*integrationUserId* - integer value indicating the unique ID for the organization integration
190
user
*tenantId* - integer value indicating the unique ID for the Social Studio tenant associated
with the Salesforce organization
191

API Social Radian6

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

API Social Radian6

Caricato da

Copyright:

Formati disponibili

Social Studio API Developer's

GETTING STARTED WITH THE SOCIAL STUDIO API . . . . . . . . . . . . . . . . . . . . 1

GENERAL DEVELOPER INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 2: Rate Limiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 7: Imported Posts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Chapter 8: Shared Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 9: Short URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Chapter 10: Publish Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Chapter 11: Approval Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Chapter 12: Social Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Retrieve Topic Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Chapter 14: Keyword Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Chapter 15: Sources and Source Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Chapter 16: Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Chapter 17: Regions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Chapter 18: Media Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Chapter 19: Posts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Chapter 20: Engage Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Create Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

CHAPTER 1 Introducing Social Studio REST API

Enable API Applications for your Organization

Register an API Application in Social Studio

Authorization (web server flow)

response_type Either one of the following two elements: code - Server-side

Web Server Flow

Requesting an Access Token (Resource Owner Password)

*authorizationCode - code returned by following the instructions in the *Authorization

Refresh the Access Token

HTTP/1.1 401 Unauthorized

HTTP/1.1 400 Bad Request

Revoking an Access Token

CHAPTER 2 Rate Limiting

*X-RateLimit-Limit* - limit for the current endpoint type

Retrieve Author Tags

Delete Author Tags

*id* - string value indicating the author of a post (required)

Request Parameter Example

*id* - string value indicating author

A call referencing a nonexistent author returns a 404 error.

Create Author Tag

*authorId* - Integer value indicating the ID of the specific author (required)

Request Parameters Example

The call below passes an array of tags to the author.

Delete Author Tag

*authorId* - Integer value indicating the ID of the specific author (required)

Request Parameters Example

Delete Author Tags

*authorId* - Integer value indicating the ID of the specific author (required)

Request Parameters Example

Create Comment for Author

*id* - string value indicating the author of a post (required)

Request Parameters Example

"value": "i heart talk radio"

Retrieve Comment for Author

*id* - string value indicating the author of a post (required)

Request Parameter Example

"value": "i heart talk radio",

*data* - array of information on comment

Delete Author Comment

*id* - string value indicating the author of a post (required)

Request Parameters Example

Retrieve Client Information

Request Parameter Example

*id* - integer value identifying organization

authorizationCode - code returned by following the instructions in the Authorization

X-RateLimit-Limit - limit for the current endpoint type

id - string value indicating the author of a post (required)

id - string value indicating author

authorId - Integer value indicating the ID of the specific author (required)

authorId - Integer value indicating the ID of the specific author (required)

authorId - Integer value indicating the ID of the specific author (required)

id - string value indicating the author of a post (required)

id - string value indicating the author of a post (required)

data - array of information on comment

id - string value indicating the author of a post (required)

id - integer value identifying organization

timeZone - string value for time zone associated with organization

id - integer value indicating unique ID for user

id - integer value indicating unique ID for user

username - string value including network username for user (required)

username - string value including network username for user (required)

engage - string value containing user engage permissions

status - string value indicating success of call

id - string value identifying the workspace to retrieve

include - comma-separated string values of additional information to include:

status - string value indicating success of call

status - string value indicating success of call

status - string value indicating success of call

id - string value containing the ID value for the workspace

status - string value indicating success of call

workspace_id - string value identifying owner of workspace resources (required)

status - string value indicating success of call

workspace_id - string value identifying owner of workspace resources (required).

status - string value indicating success of call

workspace - integer value indicating the workgroup

id - string value indicating ID of imported content

status - string value indicating success of call

shared_workspaces - array including information on workspaces sharing content

metrics - array of information on content

id - ID for the clip (required)

status - string value indicating success of call

status - string value indicating success of call

id - ID for the clip (required)

status - string value indicating success of call

ID - ID for the clip (required)