API Reference

Query Members

get
https://neon-loyalty-qa.spika.com/loyalty/v1//funnels//members
Path Params
string
required

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

string
required

One of:

  • The Entity's internal Entity Id
  • The Entity's name
  • The Entity's business Id, prefixed with $
Query Params
string

Returns Members for a specific step

string
enum

Returns Members who's step has a specific state.

Allowed:
string

Optional Dimension Filter query.
For example: dimf=language:en,sv;cmp:summer*;

string

Query field used to limit the result by other attributes.
This includes data json attributes, for example qry=data.segment[0].score:>=10
See Query instructions for format.

int32
Defaults to 0

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

int32
Defaults to 100

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

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.

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.

string

The Dimensions under which the calling application operates. Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

boolean

If true, returns resources even if the Entity's Dimension filter doesn't match the passed in Dimensions. Default is false.

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

Response

Updated 10 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago