Dimension Combinations Report

get https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/reporting/dimensions/{dimensionLookupId}/combinations

This report shows all Dimension combinations for a specific Dimension, together with statistics of how frequent and recent each value has been used.

Path Params

space

string

required

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

dimensionLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

value

string

Optionally limiting the report by Dimension Value. Query expressions are allowed, for example value=A..Z,a..z

Note that Dimension Values are case sensitive.

entityLookupId

string

Only show Dimension Values that's been used together with a particular Entity.

entityType

string

Only show Dimension Values that's been used together with a particular Entity Type.

entityCategory

string

Only show Dimension Values that's been used together with a particular Entity Category. Query expressions allowed.

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

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://neon-loyalty-qa.spika.com/loyalty/v1/space/reporting/dimensions/dimensionLookupId/combinations?page=0&pageSize=100&sort=created' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK