Description
This API retrieves Gigya's reporting data for social networks.
Request URL
us1.gigya.com
- For the US data center.eu1
- For the European data center..gigya.com
au1
- For the Australian data center..gigya.com
ru1
- For the Russian data center..gigya.com
cn1
- For the Chinese data center..gigya-api.cn
If you are not sure of your site's data center, see Finding Your Data Center.
Parameters
Required | Name | Type | Description | ||||||||||||||||||||
| startDate | string | The first day of data to include in the report, in the format "YYYY-MM-DD". | ||||||||||||||||||||
| endDate | string | The last day of data to include in the report, in the format "YYYY-MM-DD". | ||||||||||||||||||||
| dimensions | string | A comma-separated list of dimensions to include in the report, e.g., "date,ageGroup,gender". The report data will be grouped by these dimensions. The currently supported dimensions are:
For additional information see Reports and Analytics. | ||||||||||||||||||||
| measures | string | A comma-separated list of measures (data fields) to include in the report. The currently supported measures are:
For additional information see Reports and Analytics. | ||||||||||||||||||||
| providers | string | A comma-separated list of providers to include in the report. The report data will be filtered by these providers. The currently supported providers are: 'facebook', googleplus, 'twitter', 'yahoo', 'microsoft', 'line', 'linkedin', 'qq', 'renren', 'sina' , vkontakte , wechat (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). | ||||||||||||||||||||
| cid | string | The cid ("context ID") lets you filter the report data by site/application context. Each Gigya transaction may be associated with a cid (a string of maximum 100 characters length). The cid allows you to associate the report information with your own internal data, for example, to identify a specific widget or page on your site/application. | ||||||||||||||||||||
| dataFormat | string | Determines the format of the data field of the response. The options are either "csv" (default) or "json". | ||||||||||||||||||||
|
Authorization Parameters
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:
- accounts.login
- socialize.login
- accounts.notifyLogin
- socialize.notifyLogin
- accounts.finalizeRegistration
- accounts.linkAccounts
Please refer to the Authorization Parameters section for details.
Response Data
Field | Type | Description | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
headers | array of strings | The headers of the response data. | ||||||||||||||||||||||||
data | CSV | The reports' data in CSV format. |
A field that does not contain data will not appear in the response.
Response Example
{ "statusCode": 200, "errorCode": 0, "statusReason": "OK", "callId": "b033de6f1f2b48a2863aa8e69eca70de", "time": "2015-03-22T11:42:25.943Z", "headers": [ "provider", "cid", "statusUpdates", "streamPosts", "referrals", "notifications" ], "data": "provider,cid,statusUpdates,streamPosts,referrals,notifications\r\n Facebook,,0,6,3,0\r\n Yahoo,,0,2,0,0\r\n twitter,,0,1,3,0\r\n Email,,0,0,1,0\r\n LinkedIn,,0,2,0,0\r\n FacebookLike,news,0,1,0,0\r\n LinkedIn,news,0,1,0,0\r\n Facebook,news,0,1,0,0\r\n GooglePlusOne,news,0,1,0,0\r\n Facebook,,0,1,0,0\r\n Facebook,,0,1,0,0\r\n FacebookLike,news,0,1,0,0\r\n Messenger,news,0,1,0,0\r\n twitter,,0,1,3,0\r\n" }