Skip to main content
Skip to main content
Sign in Get support

Hi, how can we help?

Request Query Parameters

UXCam Data Access API accepts following parameters.

Note : Please do not use whitespace in request query parameters.

 1.1 Authentication Parameter

Access to the data for a given application is granted only after the authentication process is successful. The identity of each application is unique and is represented by the App id. Similarly, each App id has one and only one valid authentication key. You can create or update your authentication key from the Account Settings. 

So the App id is used to recognize the identity of the given application while the API key is used to authenticate it. The authentication parameters can be submitted directly on the request header or through the request URL.

1 App id 606d8e6085bcf8071116b7ba
2 API key 7089e24e-9aea-41e3-a6db-2b1e9b8c295c

1.2 Pagination Parameters

 

The bulk response received from the API can be sliced using the pagination option. By default every response will contain 50 rows per page. For instance, the following HTTP request will return the first page with 50 sessions for the given App id. 

https://api.uxcam.com/session/?appid=606d8e6085bcf8071116b7ba&apikey=7089e24e-9aea-41e3-a6db-2b1e9b8c295c&page=1&showonly={"property":1,"user":1,"location":1,"device":1}

 

You can also customize the number of rows by using the size filter. The upper limit for the number of rows returned using the size filter is 500. For instance, the following HTTP request will return the second page with 100 sessions for the given App id.

https://api.uxcam.com/session/?appid=606d8e6085bcf8071116b7ba&apikey=7089e24e-9aea-41e3-a6db-2b1e9b8c295c&page=2&size=100

1.3 Filter Parameters

1.3.1 Session List API Filter

Filter parameters are used to filter the results based on the desired attributes. The filters can be applied as a list of dictionaries where each dictionary item is a separate filter. Each filter parameter has a filter name used as a key while the value contains the operator and the actual value for the given parameter. All valid filter parameters, their respective types, and the operators are listed below:

  Parameter Data Type Description Example
1

page

Unsigned integer

The page to retrieve. Each page contains up to 100 results. The default page is set to 1               

 
page=1

2

sessiondate 

Date in format (‘yyyy-mm-dd’)

Date on which the session was uploaded

 
filter=[{"sessiondate":{"operator":"between_dates","value":{"from": "2020-05-01","to": "2020-07-01"}}}]

3

country

string

Country name based on device IP address

 
filter=[{"country":{"operator": "is", "value":"Germany"}}]

4

countrycode

string

Two letter country code of session country based on device IP address.

 
filter=[{"countrycode":{"operator": "is","value":"GB"}}]

5

appversion

string

App version on the device when session was run

 
filter=[{"appversion":{"operator": "is", "value":"1.0" }}]

6

video

bool (true/false)

Is there a video for the session?

Value is set to true and false for sessions with no video

 
filter=[{"video":{"operator":"is","value":"true"}}]

7

UXCamuserid

string

UXCam User ID of user

 
filter=[{"uxcamuserid":{"operator":"is","value":"efc3d9a623a7d482e42d73e

8

platform

Bool string

Platform (iOS or Android) of user

Value set to android for sessions having device os is ANDROID platform.

And value set to ios for sessions having device os is iOS platform.

 For android device : 
filter=[{"platform": {"operator":"is","value":"android"}}]

 

For IOS device : 
filter=[{"platform": {"operator": "is", "value": "ios"}}]

9

sessionhashofuser

Unsigned integer

count of session for the particular user. View user 10th session with UXCamuserid 

 
filter=[{"sessionhashofuser":{"operator":"is","value":1}},{"uxcamuserid":{"operator": "is","value":"5efc3d9a623a7d482e42d73e"}}]

10

osversion

string

Device operating system version

 
filter=[{"osversion":{"operator":"is","value": "6.0.1"}}]

11

crashed

bool 

Show only sessions that are crashed / not crashed

The value set to true for crashed sessions and false for not crashed sessions

 
filter=[{"crashed":{"operator": "is","value":true}}]

12

eventname

list

List of events that occurred during the session

 
filter=[{"eventname":{"operator":"hasany", "value": ["ragetap"]}}]

13

screenname

list

List of screens visited during the session

 
filter=[{"screenname": {"operator":"hasany", "value":["mainactivity"]}}]

14

sdkversion

string

UXCam SDK version on device

 
filter=[{"sdkversion": {"operator":"is", "value": "3.2.2-beta.3"}}]

15

sessionlength

float

Total session length in seconds

 
filter=[{"sessionlength":{"operator":"gt","value":10}}]

16

totalgesture

Unsigned integer

Total gesture count

 
filter=[{"totalgesture":{"operator":"gt","value":10}}]

17

screencount

Unsigned integer

Total number of screens visited

 
filter=[{"screencount":{"operator":"gt","value":10}}]

18

alias

string

Only sessions where random alias is
"Manisha Bastola"

 
filter=[{"alias":{"operator":"is","value":"Ilyas Kustermann"}}]

19

useridentity

string

Only sessions where useridentity is not "Yetika Rai"

 
filter=[{"useridentity": {"operator":"isnot","value": "Yetika Rai" }}]

20

showonly 

dict 

View only desired response section
 

 
showonly={"property":1,"user":1,"location":1,"device":1}

Example

https://api.uxcam.com/session/?appid=5e96a0513596b900b44eeafa&apikey=653370bf-79f4-4a88-b9b3-5e2757d41864&filter=[{"country": {"operator": "is", "value":"Germany" }},{"appversion": {"operator": "is", "value":"1.0" }},{"video": {"operator": "is", "value": true}}]

The above example contains three filters: 

  • Country where value is equal to Germany 
  • Appversion value is equal to 1.0 
  • Video value is equal to true

 

1.3.2 User List API Filter

  Parameter Data Type Description Example
1

page

Unsigned integer

The page to retrieve. Each page contains upto 100 results. Default page is set to 1               

page=1
2

lastseenon 

Date in format (‘yyyy-mm-dd’)

Date of last user session

 
filter=[{"lastseenon":{"operator":"between_dates","value":{"from": "2020-05-01","to": "2020-07-01"}}}]
3

registeredon

Date in format (‘yyyy-mm-dd’)

Date of first user session

 
filter=[{"registeredon":{"operator":"between_dates","value":{"from": "2020-05-01","to": "2020-07-01"}}}]
4

country

string

Two letter country code of session country based on device IP address.

 
filter=[{"country":{"operator": "is", "value":"Nepal"}}]
5

countrycode

string

Country name based on device IP address

 
filter=[{"countrycode":{"operator": "is","value":"NP"}}]
6

city

string

City name based on device IP address

 
filter=[{"city":{"operator": "is","value":"Kathmandu"}}]
7

appversion

string

App version on the device when session was run

 
filter=[{"appversion":{"operator": "is", "value":"1.0" }}]
8

uxcamuserid

string

UXCam User ID of user

 
filter=[{"uxcamuserid":{"operator":"is","value":"5efc3d9a623a7d482e42d73e"}}]
9

platform

Bool string

Platform (iOS or Android) of user

Value set to android for sessions having device os is ANDROID platform.

And value set to iOSfor sessions having device os is iOS platform.

 For android device : 
filter=[{"platform":{"operator":"is","value": "android"}}]

 

For IOS device : 
filter=[{"platform": {"operator": "is", "value": "ios"}}]
10

osversion

string

User device operating system version

 
filter=[{"osversion":{"operator":"is","value": "6.0.1"}}]
11

totalsession

Unsigned integer

Total user session count

 
filter=[{"totalsession":{"operator":"gt","value":10}}]
12

totalsessiontime

float

Time user spent on sessions

 
filter=[{"totalsessiontime":{"operator":"gt","value":10}}]
13

totalgesture

Unsigned integer

Total user gesture count

 
filter=[{"totalgesture":{"operator":"gt","value":10}}]
14

screencount

Unsigned integer

Total number of screens visited

 
filter=[{"screencount":{"operator":"gt","value":10}}]
15

eventcount

Unsigned integer

Total number of events of users

 
filter=[{"eventcount":{"operator":"gt","value":10}}]
16

ragegesturecount

Unsigned integer

Total number of rage gestures by users

 
filter=[{"ragegesturecount":{"operator":"gt","value":5}}]
17

responsivegesturecount

Unsigned integer

Total number of responsive gestures by users

 
filter=[{"responsivegesturecount":{"operator":"gt","value":5}}]
18

unresponsivegesturecount

Unsigned integer

Total number of crashes on screen

 
filter=[{"unresponsivegesturecount":{"operator":"gt","value":5}}]
19

deviceid

string

device id of users' device

 
filter=[{"deviceid":{"operator":"is","value":"ed0dfc3e6577aeea"}}]
20

devicemodel

string

Model name of users' device

 
filter=[{"devicemodel":{"operator":"is","value":"MotoG3"}}]
21

alias

string

Only sessions where random alias is
"Manisha Bastola"

 
filter=[{"alias":{"operator":"isnot","value":"Manisha Bastola"}}]
22

username

string

Only sessions where set user name is not
"tina Rai"

 
filter=[{"username": {"operator":"isnot","value": "tina Rai"}}]

Example

https://api.uxcam.com/session/?appid=606d8e6085bcf8071116b7ba&apikey=7089e24e-9aea-41e3-a6db-2b1e9b8c295c&filter=[{"country": {"operator": "is", "value":"USA" }},{"appversion": {"operator": "is", "value":"1.0" }},{"video": {"operator": "is", "value": true}}]

The above example contains three filters:

  • Country where value is equal to USA
  • Appversion value is equal to 1.0
  • Video value is equal to true

 

1.3.3 Filter Operators

1.3.3.1 Integer Operators

The following table shows the use of different integer or float operators for a given parameter (totalgesture). 

  Operator Name Operator Symbol Operator Data type Example
1

gt

>

float

 
filter=[{"totalgesture":{"operator":"gt","value":10}}]
2

lt

<

float

 
filter=[{"totalgesture":{"operator": "lt","value":10}}]
3

geq

>=

float

 
filter=[{"totalgesture":{"operator":"geq","value":10}}]
4

leq

<=

float

 
filter=[{"totalgesture":{"operator": "leq","value":10}}]

 

1.3.3.2 String Operators

The following table shows the use of different string operators for a given parameter (appversion).

  Operator Name Operator Symbol Operator Data type Example
1

is

=

float

 
filter=[{"appversion":{"operator":"is","value":"1.0"}}]
2

isnot

!=

float

 
filter=[{"appversion":{"operator": "isnot","value":"1.0"}}]
3

in

∈

list (float)

 
filter=[{"appversion":{"operator": "in","value":["1.0","2.0"]}}]
4

notin

∉

list (float)

 
filter=[{"appversion": {"operator":"notin","value":["1.0","2.0"]}}]
5

contains

Contain substring

string

 
filter=[{"appversion":{"operator":"contains","value":"1.0"}}]
6

containsnot

Does not Contain substring 

string

 
filter=[{"appversion": {"operator":"containsnot","value":"1.0"}}]

 

1.3.3.3 List Operators

The following table shows the use of different list (string) operators for a given parameter (eventname):

  Operator Name Operator Symbol Operator Data type Example

1

hasany

=

list (string)

 
filter=[{"eventname":{"operator":"hasany","value":["ragetap","login"]}}]

2

nothasany

!=

list (string)

 
filter=[{"eventname":{"operator":"nothasany","value":["ragetap","login"]}}]

3

hasall

∈

list (string)

 
filter=[{"eventname":{"operator":"hasall","value":["ragetap","login"]}}]

4

nothasall

∉

list (string)

 
filter=[{"eventname":{"operator":"nothasall","value":["ragetap","login

 

1.3.3.4 Datetime Operators

The following table shows the use of different datetime operators for a given parameter (sessiondate):

  Operator Name Operator Symbol Operator Data type Example

1

on

=

Date string 

 
filter=[{"sessiondate":{"operator": "on","value":"2020-05-26"}}]

2

noton

!=

Date string 

 
filter=[{"sessiondate":{"operator":"noton","value":"2020-05-26" }}]

3

after

>

Date string 

 
filter=[{"sessiondate":{"operator":"after", "value":"2020-05-26"}}]

4

since

>=

Date string 

 
filter=[{"sessiondate":{"operator":"since", "value":"2020-05-26"}}]

5

untill

<=

Date string 

 
filter=[{"sessiondate":{"operator": "untill", "value":"2020-05-26"}}]

6

before

<

Date string 

 
filter=[{"sessiondate":{"operator":"before","value":"2020-05-26"}}]

7

in

∈

Date string 

 
filter=[{"sessiondate":{"operator":"in","value":["2020-05-26","2020-05-29"]}}]

8

notin

∉

Date string 

 
filter=[{"sessiondatePra":{"operator":"in","value":["2020-05-26","2020-05-29"]}}]

9

between_dates

between

Date string 

 
filter=[{"sessiondate":{"operator":"between_dates","value":{"from":"2020-05-01","to":"2020-06-01"}}}]

1.4. Session Response Filter

The Session List API allows 5 types of response filter parameters. You can filter out the response using the showonly response filter. The server will include the data for the given parameter if you set the value of the response parameter filter to 1. Similarly you can set the value of the response filter parameter to 0 which will exclude response data from the output for the specific parameter.

Example:

showonly={"property":1,"user":1,"location":0,"device":0}

https://api.uxcam.com/session/?appid=606d8e6085bcf8071116b7ba&apikey=7089e24e-9aea-41e3-a6db-2b1e9b8c295c&page=1&showonly={"property":1,"user":0,"location":1,"device":1}