/membervalues/asof/{datetime} – Alida Help Center

GET the Member Values as of a specific point in time. A special case of this is to use the date-time 9999 which will return the current or latest Member Values. This is convenient for cases where historical information is not required nor desired.

Resource URL

/v1/applications/{communityApiKeyName}/membervalues/asof/{datetime}

Note:

Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.

Available Methods

Method	Description
GET	Get a collection of member variables.

Note:

For Member Variables with the returnLatest constraint set (e.g. memberstatus, email), the latest Member Value will be returned even if a date-time in the past has been specified.
The total number of Member Values for your community can be very large. Care should be taken to query this resource in the most efficient manner. For more information, see Content control.

GET request examples

Endpoint	Returns
`/membervalues/asof/2016`	All member values that are effective as of midnight January 1, 2016 UTC.
`/membervalues/asof/2016-01-31`	All member values that are effective as of midnight January 31, 2016 UTC.
`/membervalues/asof/2016-02-01T21:30:00`	All member values that are effective as of 9:30 PM February 1, 2016 UTC .
`/membervalues/asof/9999`	The latest member values.

Parameters

Parameters can be appended to the request to further refine the results returned.

Operation	Description	Example
Refine the response by field	To reduce the number of fields returned, specify the fields in a comma separated list.	`/membervalues/asof/{datetime}?fields=memberEmail`
Filtering by value	By default, all the items are returned unless you specify your criteria using the variable name and value. You can filter the results on all of the available fields except for: `id` `links`	`/membervalues/asof/{datetime}?memberEmail=email@example.com` Tip: If the `memberVariableValue` is a string, but the member variable value is actually an integer, then format your query string as `q=memberVariableValue="integer"`. For example, `/membervalues?membervariablename=groupId&q=memberVariableValue="123"`
Paging	By default, 20 are items are returned at a time. The maximum is 1000.	Use the `limit` and `offset` query string parameters to effectively page through the results.
Sorting	You can sort the results on all of the available fields except for: `communityId` `href` `id` `links` `memberDataSetType` `memberEmail`	`/membervalues/asof/{datetime}?sort=memberId:d`

For more information, see Content control.

Field Descriptions

Field	Description
`communityId`	This field is deprecated and will likely be removed from this resource. Please do not use.
`createDate`	Date and timestamp (UTC) the Member Value was created.
`createdBy`	GUID of the user who created the Member Value.
`effectiveDate`	This field exposes the time-series aspect of Member Value data. The date-time is formatted as UTC at which this Member Value is effective. The implication is that the said Member Value is valid from this time forward, unless another Member Value is recorded at a later point in time, in which case the newer Member Value would then take precedence.
`href`	Link to the Member Value.
`id`	GUID of the Member Value.
`lastUpdateDate`	Date and timestamp (UTC) the Member Value was last updated.
`lastUpdatedBy`	GUID of the user who last updated the Member Value.
`links`	This field will always be empty.
`memberDataSetType`	`Live` or `Test`, distinguishing if this Member Value represents test data or live data.
`memberEmail`	The current email address for the member to whom this Member Value belongs. Note: `memberEmail` is modeled and stored as a System Variable called email, but returned here for convenience given the prominence of email as an external identifier for members.
`memberId`	The GUID of the member to whom this Member Value belongs.
`memberSequenceId`	The integer ID of the member to whom this Member Value belongs.
`memberVariableId`	The GUID of the Member Variable to which the assigned Member Variable Value belongs.
`memberVariableName`	The name of the Member Variable to which the assigned Member Variable Value belongs.
`memberVariableSequenceId`	The integer ID of the Member Variable to which the assigned Member Variable Value belongs.
`memberVariableType`	The type of Member Variable to which the assigned Member Variable Value belongs.
`memberVariableValue`	The value of the Member Variable Value being assigned.
`memberVariableValueId`	The GUID of the Member Variable Value being assigned.
`memberVariableValueSequenceId`	The integer ID of the Member Variable Value being assigned.

GET response structure


{
  "meta": {
    "offset": 0,
    "limit": 1,
    "count": 1
  },
  "items": [
    {
      "id": <GUID of member value>,
      "communityId": <deprecated>,
      "memberId": <GUID of member>,
      "memberEmail": <current email address of member>,
      "memberVariableId": <GUID of member variable>,
      "memberVariableName": <name of member variable>,
      "memberVariableType": <type of member variable>,
      "memberVariableValueId": <GUID of member variable value>,
      "memberVariableValue": <value of member variable value>,
      "memberSequenceId": <integer ID of member>,
      "memberVariableSequenceId": <integer ID of member variable>,
      "memberVariableValueSequenceId": <integer ID of member variable value>,
      "memberDataSetType": <Live|Test>,
      "effectiveDate": <date-time (UTC) as of when this member value became effective>,
      "createDate": <date-time (UTC of create date)>,
      "lastUpdateDate": <date-time UTC of last update>,
      "createdBy": <GUID of user>,
      "lastUpdatedBy": <GUID of user>,
      "links": [],
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervalues/{membervaluesId}"
    }
  ],
  "links": [
    {
      "rel": "first",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervalues?limit=1&offset=0"
    },
    {
      "rel": "prev"
    },
    {
      "rel": "last",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervalues?limit=1&offset=1688"
    },
    {
      "rel": "next",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervalues?limit=1&offset=1"
    }
  ],
  "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervalues?limit=1"
}