Query Activities

get https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/activities

Queries the Member Activity database.

Note that this can be a very heavy operation with large result sets, so where possible specify at least one of the member or entity attributes to reduce the volume of rows.
Also add as many other qry and dimf attributes as possible, and don't specify countTotals unless absolutely necessary.

This operation scans all Activities except where the Member has been flagged as DELETED.

Path Params

space

string

required

The name of the space (database) assigned to you.

Query Params

member

array of strings

Optional comma-separated list of Member Lookup Ids to query by.
Note, if more than one value then all must be of the same lookup type.

member

entity

array of strings

Optional comma-separated list of Entity Lookup Ids to query by.

Note, if more than one value then all must be of the same lookup type.

entity

dimf

string

Optional Dimension Filter query.

For example: dimf=language:en,sv;cmp:summer*;

qry

string

Query field used to limit the result by other attributes. Supported fields are:

'activityId', 'activity', 'specifics', 'created', 'entered'. Example qry=activity:click,open.
Note that when searching the 'entered' field, it will use created if the entered field is empty.
data json field attributes, by prefixing with 'data.'. Example: qry=data.segment[0].score:>=10
Members table fields, by prefixing with '_members'. Example: qry=_members.state:ACTIVE
The Entity type, subType, state and category fields, prefixed with 'entity_'. Example: qry=entity_type:VOTE,SURVEY

Full Query Expressions are supported.

page

int32

Defaults to 0

Used together with pageSize. First page is zero, which is also the default.

pageSize

int32

Defaults to 100

Specifies the number of items to return per page. Default is 100.

sort

string

Defaults to created

Overrides the default sorting. Useful together with pagination.
One or more sort attributes can be specified, and it's possible to control ascending or descending order, or example 'name,-created'.
It's normally possible to specify any of the fields in the content.
Note, that sorting can slow down execution for large data sets.

countTotals

boolean

Works with pagination. If true, counts total number of rows and pages before the page is returned.
Default is to not count totals. Use with caution as setting to true may have a severe impact on performance for large result sets.

Response

200OK