The Social Report SDKs gets your app connected quickly and easily, so you can focus on creating an experience. Social Report exposes its data via an Application Programming Interface (API), so developers can interact in a programmatic way with the Social Report website. This document is the official reference for that functionality.
The purpose of this API is to allow anyone to build applications that interact with social networks using a unified API without having to worry about integrating with each network separately.
The current API version is 1.0
IMPORTANT: All requests have to be signed using an api key that. Simply add "api_key" request header when making all requests. For testing purposes you can also pass "api_key" as a parameter. This is not a recommended option however for obvious security reasons.
Get a list of all projects belonging to the owner of the API key.
Parameters
Output
[
{
"id": "56783",
"name": "SocialReport.com",
"user": 5
},
{
"id": "76897",
"name": "WebAlgorithm LLC"
},
{
"id": "45765",
"name": "ConcreteMedia Inc",
"user": 7
}
]
Create a new project. Project is a way of grouping a set of social properties. Typically project represents a client, a business or a marketing initiative.
Parameters
Output
[
{
"id": "56783"
}
]
Get a project summary for a project - analytical summary of social trends
Parameters
Output
{
"project": 56783,
"name": "SocialReport.com",
"summary": {
"date": "20120502",
"accounts": 25,
"networks": 19,
"friends": 2107,
"mostPopulaNetwork": "LinkedIn",
"mostPopulaNetworkShare": 0.0002,
"mostPopularLanguages": "English,Spanish,Italian",
"membershipGrowth": 0.00128,
"activityGrowth": -0.00729,
"activeCountries": "United States,Italy,India",
"engagement": 0.601,
"engagementGrowth": 0.001,
"dailyClicks": 0.011,
"averageAge": 35,
"countries": 47,
"numberOfLanguages": 37,
"mostActiveCities": "New York,Brooklyn,Jersey City",
"mostActiveStates": "Connecticut,Illinois"
}
}
Add user to the project. Users can be your members of the team or customers. Each user gets a very specific set of permissions.
Parameters
Output
[
{
"id": "6543"
}
]
Make changes to your project users - their profile data and permissions.
Parameters
Output
[
{
"id": "6543"
}
]
Remove user from the project. This strips the user from all access to the given project.
Parameters
Output
[
{
"status": "ok"
}
]
Get a list of users who have access to the given project.
Parameters
Output
[
{
"id": "11833",
"lastName": "johnson",
"added": "20111031",
"email": "user1@company.com",
"active": "yes",
"firstName": "roger",
"deleted": "no"
},
{
"id": "11317",
"lastName": "robinson",
"added": "20111031",
"created": "20100901",
"email": "user2@company.com",
"active": "no",
"firstName": "peter",
"deleted": "no"
}
]
Get a list of all accounts for a project. Accounts are the actual social properties: twitter profiles, facebook pages, etc.
Parameters
Output
[
{
"id": "65789",
"name": "web@lgorithm",
"active": "yes",
"type": "T"
},
{
"id": "45678",
"name": "SocialReport.com",
"active": "yes",
"type": "F"
},
{
"id": "62821",
"name": "@TheSocialReport",
"active": "yes",
"type": "F"
},
{
"id": "87601",
"name": "socialreport",
"active": "yes",
"type": "BITLY"
},
{
"id": "248",
"name": "Dunkin Donuts",
"active": "yes",
"type": "YELP"
}
]
Get a list of all campaigns for a project. Campaigns are publications into mutliple social channels with ability to track clicks and conversions.
Parameters
Output
[
{
"id": "1061",
"status": "pending",
"name": "sr blog",
"type": "RSS"
},
{
"id": "1059",
"status": "inprogress",
"name": "monday 9:37",
"type": "L"
}
]
Export all account data. Note that this result is a downloadable zip archive file.
Parameters
Additional parameters. Value 1 indicates the need to export data
Output
Register new customers. Note that this API must be used over SSL and only accept "POST" request.
Parameters
Output
[
{
"status": "ok",
"user_id": "595959532"
}
]
Retrieve your customers. If you are an affiliate and/or have an integrated registration process - this method will allow you to retrieve all of your customers and their payment details.
Output
[
{
"id": "877272",
"enabled": "no",
"firstName": "Brian",
"lastName": "Gordon",
"subscription": {
"plan": "Professional",
"balance": "0",
"expected": "0",
"monthly": "39",
"nextPaymentDate": "20111210",
"payments": []
},
"created": "20111110"
},
{
"id": "3311111",
"enabled": "yes",
"firstName": "Jason",
"lastName": "Smith",
"subscription": {
"plan": "Professional",
"balance": "39",
"expected": "78",
"monthly": "39",
"nextPaymentDate": "20111210",
"payments": [
{
"date": "20110910",
"amount": "39",
"status": "ok"
},
{
"date": "20111010",
"amount": "39",
"status": "failed"
}
]
},
"created": "20111109"
}
]
Create a new keyword search agent
Parameters
Output
[
{
"id": "326"
}
]
Get a list of all search agents for a project. Search agents allow you to search social space for keywords that interest you.
Parameters
Output
[
{
"id": "65299",
"name": "social media",
"initialized": "yes"
},
{
"id": "54321",
"name": "social report",
"initialized": "yes"
}
]
Modify an existing keyword agent.
Parameters
Output
[
{
"id": "464"
}
]
Delete an existing keyword agent
Parameters
Output
[
{
"status": "ok"
}
]
Create a new social account. Don't forget to add your account to a project.
Parameters
Output
[
{
"id": "326"
}
]
Update an existing social account
Parameters
Output
[
{
"id": "326"
}
]
Remove an existing account
Parameters
Output
[
{
"status": "ok"
}
]
Add an existing social account to project
Parameters
Output
[
{
"status": "ok"
}
]
Remove account from project
Parameters
Output
[
{
"status": "ok"
}
]
Authenticates the user, generates single sign-on token. You can then use generate token direct your user to https://api.socialreport.com/sso.htm?token=generated_token which will seamlessly log the user into his or her Social Report account. Note that if you are using a white labeled domain - you can substitute api.socialreport.com with your domain.
Generated tokens are only valid for 30 seconds once generated.
Parameters
Output
[
{
"token": "0hokth7bh7rbbmravhabcam4uo27gx9cec46"
}
]
Get a user information.
Parameters
Output
[
{
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@test.com",
"username": "john",
"defaultLanguage": "en",
"timezoneId": "America/Virgin",
"currencyCode": "USD",
"customization": "{"showNotifications":"yes",
"showAskUs":"yes",
"api_key":"user's_api_key",
"showNews":"yes",
"active":"yes",
"showUserProfile":"yes",
"language":"en",
"logo": "logo_image.png",
"name": "reseller's name",
"domain": "thedomain.com",
"affiliateCode": "welcome",
"whiteLabel":"yes"}"
}
]
Create a new user.
Parameters
Output
[
{
"status": "ok",
"user_id":"1232245"
}
]
Update an existing user.
Parameters
Output
[
{
"status": "ok",
"user_id": "12123"
}
]
Customize white label setup
Parameters
Output
[
{
"status": "ok"
}
]