reports.getSocializeStats REST

Skip to end of metadata
Go to start of metadata

Description

This API retrieves Gigya's reporting data.

Request URL


Where <Data_Center_ID> is:
  • us1 - For the US data center.
  • eu1 - For the European data center.
  • au1 - For the Australian data center.
  • ru1 - For the Russian data center.

If you are not sure of your site's data center, see Finding Your Site's Data Center.

Parameters

RequiredNameTypeDescription
startDatestringThe first day of data to include in the report, in the format "YYYY-MM-DD".
endDatestringThe 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:

  • date
  • cid - Context ID. See the description of the "cid" parameter below.
  • provider
  • ageGroup - This will group the data by "1" for ages 12 and under, "2" for ages 13-17, "3" for ages 18-34, "4" for ages 35-49 and "5" for ages 50 and above.
  • gender - The data will be grouped by "Male", "Female" or "" (unspecified gender).

measures

string

A comma-separated list of measures (data fields) to include in the report.

The currently supported measures are:

  • statusUpdates
  • streamPosts
  • referrals
  • notifications
  • newUsers
  • newSiteUsers
  • newConnections
  • logins
  • siteLogins
  • postBookmarks
  • emailRecipients
  • socializePV - This measure counts the number of times gigya.js had been called ('impressions'), and is only supported by sites implementing the JS with the API key in the url.
    Notes: 
    • For the socializePV measure, the optional providers and cid dimensions (below) should always be empty. If you set the providers or cid dimensions with a value other than empty strings, you will receive zero impressions.
    • socializePV is only supported via the date dimension. Attempting to call socializePV as a measure while using any other dimensions will cause the query to fail.
  providersstringA 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', 'twitter', 'yahoo', 'microsoft', 'linkedin', 'qq', 'renren', 'sina' (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used).
cidstringThe 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.
dataFormatstringDetermines the format of the data field of the response. The options are either "csv" (default) or "json".
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 

Response Data

FieldTypeDescription
 
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
statusReason string A brief explanation of the status code.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
headersarray of stringsThe headers of the response data.
dataCSVThe 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"
}

Unable to render {include} The included page could not be found.