Social Report API
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 current API version is 1.0
API Key
You can obtain an API from your account. Navigate to My Account and then API. If you don't have an account, you can sign up now.
REST API
- /projects.svc
- /projectCreate.svc
- /projectAddUser.svc
- /projectUsers.svc
- /accounts.svc
- /campaigns.svc
- /agents.svc
- /export.svc
- /register.svc
- /customers.svc
- /user.svc
http://www.socialreport.com/projects.svc
Get a list of all projects belonging to the owner of the API key.
Parameters
- access_key: application key required for authentication, it is used to identify the user.
Output
- id: unique project identifier.
- project: project name.
[
{
"id": "56783",
"name": "SocialReport.com"
},
{
"id": "76897",
"name": "WebAlgorithm LLC"
},
{
"id": "45765",
"name": "ConcreteMedia Inc"
}
]
http://www.socialreport.com/projectCreate.svc
Create a new project
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- name: project name
Output
- id: unique project identifier.
[
{
"id": "56783"
}
]
http://www.socialreport.com/projectAddUser.svc
Add user to the project
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- email: user email address
- firstName: user's first name (only required for first time user setup)
- lastName: user's last name (only required for first time user setup)
- company: user's company (only required for first time user setup)
- username: user's username (only required for first time user setup)
- password: user's password (only required for first time user setup)
Output
- id: unique user identifier.
[
{
"id": "6543"
}
]
http://www.socialreport.com/projectUsers.svc
Add user to the project
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- project: project id
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"
}
]
http://www.socialreport.com/accounts.svc
Get a list of all accounts for a project
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- project: project identifier
Output
- id: unique account identifier.
- name: account name.
- type: account network type (i.e. T (Twitter), F (Facebook), etc) .
- active: activity indicator.
[
{
"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"
},
{
"id": "243",
"name": "jason",
"active": "no",
"type": "ORKUT"
},
{
"id": "262",
"name": "socialreport",
"active": "yes",
"type": "GOWALLA"
}
]
http://www.socialreport.com/campaigns.svc
Get a list of all campaigns for a project
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- project: project identifier
Output
- id: unique campaign identifier.
- name: campaign name.
- type: campaign type (i.e. L - manual, RSS - rss syndication)
- status: current campaign status.
[
{
"id": "1061",
"status": "pending",
"name": "sr blog",
"type": "RSS"
},
{
"id": "1059",
"status": "inprogress",
"name": "monday 9:37",
"type": "L"
}
]
http://www.socialreport.com/agents.svc
Get a list of all agents for a project
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- project: project identifier
Output
- id: unique campaign identifier.
- name: agent name.
- initialized: indicates if initial search has been completed.
[
{
"id": "65299",
"name": "social media",
"initialized": "yes"
},
{
"id": "54321",
"name": "social report",
"initialized": "yes"
}
]
http://www.socialreport.com/export.svc
Export all account data. Note that this result is a downloadable zip archive file.
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- export_type: support types: account, campaign, agent, conversation, address-book
- account: account (required is export_type=account)
- campaign: account (required is export_type=campaign)
- project: account (required is export_type=address-book)
- project: account (required is export_type=address-book or conversation)
- accounts: account (required is export_type=conversation)
- from: from date offset (i.e. 20110925)
- to: to date offset (i.e. 20111025). note that maximum allowed date range is 30 days.
Output
- zip file: downloadable zip file with comma delimited files representing different aspects of account data.
https://www.socialreport.com/register.svc
Register new customers. Note that this API must be used over SSL and only accept "POST" request.
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- user.firstName: customer first name
- user.lastName: customer last name
- user.address1: customer street address
- user.city: customer city
- userCountry: two letter custom code
- user.email: customer email
- user.username: customer username
- user.password: customer password
- billing.firstName: billing first name
- billing.lastName: billing last name
- billing.address1: billing street address
- billing.city: billing city
- billingCountry: two letter custom code
- billing.postCode: billing post code
- payment.cardholderNamecardhold name
- payment.numbercredit card number
- payment.cvv2card's cvv code
- expirationMonthcard's expiration month: January, Feburary, etc
- expirationYearcard's expiration year: 2012, 2013, etc
Output
[
{
"status": "ok",
"user_id": "595959532"
}
]
http://www.socialreport.com/customers.svc
Retrieve your customers.
Parameters
- access_key: application key required for authentication, it is used to identify the user.
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"
}
]
http://www.socialreport.com/user.svc
Performs user actions.
Parameters
- access_key: application key required for authentication, it is used to identify the user.
- id: your customer's user id
- action: "activate" or "deactivate"
- reason: reason for performing this action.
Output
[
{
"status": "ok"
}
]
