GAgainsight
Users

Get users

Retrieves users. Supports filtering, sorting and paging.

Filtering

The filter parameter accepts a list of semicolon-separated filters in the form: {fieldName}{operator}{fieldValue} Filter terms within a single filter parameter are joined by a logical AND. Separate filter parameters are joined by a logical OR.

Operators

OperatorMeaning
==Exact match
!=Not equal
<Less than
<=Less than or equal
>Greater than
>=Greater than or equal
~Matches string, supports wildcard characters * and ?
!~Not like, supports wildcard characters * and ?

Examples:

URIResults
GET /v1/users?filter=lastName==Doe;firstName==JohnUsers with firstName of 'John' AND lastName of 'Doe'.
GET /v1/users?filter=firstName==John;lastName=Doe&filter=firstName==BobUsers with: (firstName of 'John' AND lastName of 'Doe') OR firstName of 'Bob'.
GET /v1/users?filter=location.cityName==PortlandUsers with a city of 'Portland'.
GET /v1/users?filter=customAttributes.internalId==12345Users with a custom attribute of internalId equal to 12345'.
GET /v1/users?filter=lastInferredLocation.stateName==GeorgiaUsers with a last inferred location.stateName value of Georgia'.
GET /v1/users?filter=lastVisitedUserAgentData.userAgent.browserType==firefoxUsers with firefox as last visited browser across the products '.
GET /v1/users?filter=lastVisitedUserAgentData.userAgent.browserType==firefox;lastVisitedUserAgentData.propertyKey==AP-8MF5LPSWUBFW-2Users with firefox as last visited browser for a particular product(with property key AP-8MF5LPSWUBFW-2)'.

Supported filter fields for last inferred location

Field
lastInferredLocation.countryCode
lastInferredLocation.countryName
lastInferredLocation.stateCode
lastInferredLocation.stateName
lastInferredLocation.city
lastInferredLocation.continent
lastInferredLocation.postalCode
lastInferredLocation.regionName
lastInferredLocation.timeZone
lastInferredLocation.street

Sorting

The sort parameter accepts a list of semi-colon separated fields names, each with an optional dash to imply descending sort order. Examples:

URIResults
GET /v1/users?sort=lastName;firstNameUsers sorted by firstName, lastName, in ascending order.
GET /v1/users?sort=-createDateUsers sorted by createDate in descending order.
get/v1/users

Request

Query parameters

filterstring[]

Filters

pageSizeinteger

Number of users per page

scrollIdstring

Used for fetching subsequent pages after the first one. Returned in response.scrollId

sortstring

Sort fields

Response

Success

totalHitsinteger

Total number of records matching filters

scrollIdstring

If passed on subsequent requests as the scrollId parameter, will fetch the next page

Example response

{
  "users": [
    {
      "location": {
        "countryName": "United States",
        "countryCode": "USA",
        "stateName": "California",
        "stateCode": "CA",
        "city": "San Mateo",
        "street": "101 Broadway",
        "continent": "NA",
        "coordinates": {
          "latitude": 37.567147,
          "longitude": -122.324211
        }
      },
      "propertyKeys": [
        "AP-XXXXXXXXXX-2"
      ],
      "lastInferredLocation": {
        "countryName": "United States",
        "countryCode": "USA",
        "stateName": "California",
        "stateCode": "CA",
        "city": "San Mateo",
        "street": "101 Broadway",
        "continent": "NA",
        "coordinates": {
          "latitude": 37.567147,
          "longitude": -122.324211
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.