Gigya Job Openings

Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Gigya provides an SQL-like query language for searching and querying Profile Management. The ids.search method receives a 'query' parameter that accepts an SQL-like query string. For details of the query syntax, see the ids.search documentation.

An example of a search REST request URL (after URL encoding):

Code Block
languagejs
linenumberstrue
https://ids.gigya.com/ids.search?query=SELECT%20profile.email,profile.firstName%20FROM%20accounts&oauth_token=0000
Panel
borderColor#81C0FC
bgColor#F4F7FC
borderWidth1
borderStylesolid

Notes:

  • Always prefer accessing user accounts directly using their UIDs (with ids.getAccountInfo) rather than using search, whenever possible. Accessing user accounts directly using their UIDs is faster and optimal for run-time. 
  • After data is published to the storage, building the indexes is done asynchronously for performance reasons, and may take up to one second to complete.

...

FieldTypeDescription
UIDstringThe unique user ID. This user ID should be used for login verification as described under Validate the UID Signature in the Social Login Process.
loginProviderstringThe name of the provider that the user used in order to log in.
iRankintegerInfluencer rank of the user. The iRank is a number between 0-99, which denotes the percentile location of the user in comparison to all other site users as a site influencer. For example, if a user's iRank equals 60, this means that 60% of the site users influence less than this user, or in other words, this user is in the top 40% of site influencers.
The iRank is calculated based on the amount of exposure this user provides the site. The calculation is done for the past several months, where recent activities receive higher ranks. The iRank is per site (per API key); the same user may have different ranks for different domains. The iRank calculation uses the following parameters:
  • The number of friends this user has in all the networks to which they are connected through this site.
  • The number of times this user shared something in this site (per month).
  • The number of click backs that were made as a result of this user's shares.
lastLoginTimestampintegerThe time of the last login of the user in Unix time format, i.e., seconds since Jan.1st, 1970.
lastLoginstringThe time of the last login of the user in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".
oldestDataUpdatedTimestampintegerThe time when the oldest data of the object was refreshed in Unix time format, i.e., seconds since Jan. 1st, 1970.
oldestDataUpdatedstringThe time when the oldest data of the object was refreshed in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".
lastUpdatedTimestampintegerThe time when the last update of the object occurred (either full or partial update) in Unix time format, i.e., seconds since Jan. 1st, 1970.
lastUpdatedstringThe time when the last update of the object occurred (either full or partial update) in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".
createdTimestampintegerThe time the account was created in Unix time format, i.e., seconds since Jan. 1st, 1970. For Registration as-a Service accounts this is the time accounts.register was called, for Social Login accounts this is the first time socialize.login or socialize.notifyLogin were called. 
createdstringThe time the account was created in ISO 8601 format, e.g., "1997-07-16T19:20:30Z".
socialProvidersstringA comma-separated list of  the names of the providers to which the user is connected/logged in.
profileProfile objectThe user's profile information as described in the Profile object. 
dataJSON objectCustom data. Any data that you want to store regarding the user that isn't part of the Profile object.
identitiesarrayAn array of Identity objects, each object represents a user's social identityEach Identity object contains imported data from a social network that the user has connected to.

...