Table of contents
Description
The method allows sites to export their users list. The method retrieves a list of users' data.
Request URL
http[s]://socialize.gigya.com/socialize.exportUsers
Parameters
| Required | Name | Type | Description |
| Optional | format | string | The preferred format of the returned user data. The options are:
When format=csv the method returns a pure CSV of the result and automatically sets httpStatusCodes to 'true'. |
| fields | string | A comma separated list of fields to return in the response. Currently the only supported values are: uid, provider, providerUID and the default is "uid,provider,providerUID". | |
| limit | integer | The maximum number of users to retrieve. It is not guaranteed that the number of users returned will be equal to the limit, it only guarantees that the number of returned users will not exceed the limit, even if the number of total users in the site is greater than the limit. By default, if no limit is defind then all users are returned. |
Authorization Parameters
Each REST API request must contain identification and authorization parameters.
Note: the authorization parameters are required only if you are using the REST API directly. If you are using one of Gigya's SDKs then these parameters are not required, since the SDK implements the authorization method internally.
The set of required parameters is dependent on your selected method of authorization. There are two options:
- If you are conforming with the OAuth 2.0 standard, you will need to Pass an Access Token. In this case use a global access token that represents the application, not the user, by using socialize.getToken with grant_type=none. For more information, please read the Using Gigya's REST API in compliance with OAuth 2.0 guide.
- If you are using Gigya's proprietary authorization method, you will need to pass the parameters specified here. Or, if you are making a call over HTTPS then you may pass the secret parameter instead of the timestamp, nonce and sig parameters. For more information, please read the Using Gigya's REST API with our proprietary authorization method guide.
Response Data
| Field | Type | Description |
| 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. |
| 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. |
| users | array | An array of JSON objects that include:
|
| usersCount | integer | The number of users that were returned. |
| identitiesCount | integer | The number of identities that were returned. |
Response Example
{
"users": [
{
"UID": "_gid_t+0P1vgAjhVTw8fPs1DSJnjAr3E=",
"identities": [
{
"provider": "twitter",
"providerUID": "262710724"
},
{
"provider": "facebook",
"providerUID": "100002136853114"
}
]
},
{
"UID": "_gid_UnXMjySuZJwyz654w==",
"identities": [
{
"provider": "facebook",
"providerUID": "622098199"
}
]
},
{
"UID": "_gid_kcugodwRh72tw==",
"identities": [
{
"provider": "twitter",
"providerUID": "14047511"
}
]
},
{
"UID": "6625ID",
"identities": [
{
"provider": "site",
"providerUID": "6625ID"
},
{
"provider": "google",
"providerUID": "115480002607925776950"
}
]
},
{
"UID": "AABCWA",
"identities": [
{
"provider": "site",
"providerUID": "AABCWA"
}
]
},
{
"UID": "AAKODB",
"identities": [
{
"provider": "site",
"providerUID": "AAKODB"
}
]
},
{
"UID": "AJDPHN",
"identities": [
{
"provider": "site",
"providerUID": "AJDPHN"
}
]
}
],
"usersCount": 7,
"identitiesCount": 9,
"statusCode": 200,
"errorCode": 0,
"statusReason": "OK",
"callId": "2c69299d3bc14d65b9fe313f9f98b3ef"
}
Comments