endpoint and authentication

Please refer to the API overview section to get the API endpoint, query format and authentication process.

Events

App events

GET /api/apps/app_identifier/events?page=page&per_page=per_page&fields=fields&since_date=since_date&until_date=until_date&device_ids=device_ids&user_ids=user_ids&session_ids=session_ids...

Export endpoint (see how to use it here):

GET /api/apps/app_identifier/events_export?fields=fields&since_date=since_date&until_date=until_date&device_ids=device_ids&user_ids=user_ids&session_ids=session_ids...

Get all mobile events performed on an app. You can fetch starting from a given date, and filter by user or device identifiers.

All custom events are returned, along with the EnteringBackground and EnteringBackground which can help you identify the time spent in the app.

Query parameters

Property Type Description Default
app_identifier string The app for which you are requesting the list of events required
page integer The page of events to retrieve. Negative values will be ignored, and the default number will be used. 1
per_page integer The number of events to retrieve per page.
Range of values accepted is [1..10000]. Values outside of range are ignored, and the default value is used instead.		 1000
fields string A string with a list of event fields to present, separated by commas. For possible fields to request, see Response fields below. If there's no value for some field requested, the value null is returned for that field.
 -
since_date datetime The date in UTC since when events should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00. -
until_date datetime The date in UTC until when events should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00. -
device_ids String A string with a list of device_ids to filter by, separated by commas. -
user_ids String A string with a list of user_ids to filter by, separated by commas. -
session_ids String A string with a list of session_idss to filter by, separated by commas. -
segment_ids String A string with a list of segment identifiers to filter by, separated by commas. -
names String A string with a list of event names to filter by, separated by commas. -
details String A string with a list of event detail strings to filter by, separated by commas. -
group Boolean Allows to count the number of occurrences for the fields selected with the fields parameter. When grouping is activated, since_date has the default and maximum value of 60 days ago, or 60 days to until_date -

Response fields

Value Type Description
event_id string Always returned unless grouped results Unique identifier of the event
log_type integer Type of the log. 1 logs are errors, 2 logs are events, and 3 is used for background transition events
name string Name of the event as it was tagged in the app using the SDK
date_utc datetime Date and time of the event in UTC
date_tz datetime Date and time of the event in the time zone of the mobile device
user_id string Identifier of the user logged in when the event happened on the device
device_id string Unique identifier of the device on which the event occurred
session_id string Unique identifier of the session in which the event occurred
detail string or map Context associated to the event when it was recorded
count integer Always returned when grouped results number of occurrences of the returned fields over the period.

Response

Status: 200 OK

{
    "success": true,
    "result": {
        "items": [
            {
                "event_id": "39407325-1484066284-logs-00003",
                "session_id": "39407325-1484066284",
                "user_id": "user@gmail.com",
                "device_id": "f73314639d94f84f",
                "date_tz": "2017-01-10T17:22:40.000+01:00",
                "date_utc": "2017-01-10T16:22:40.000Z",
                "log_type": 2,
                "name": "Purchase product",
                "detail": {
                    "category": "shoes",
                    "price": 300,
                    "brand": "brand"                
                }
            },    
            {
                "event_id": "41674959-1486720502-logs-00003",
                "session_id": "41674959-1486720502",
                "user_id": "user@gmail.com",
                "device_id": "f73314639d94f84f",
                "date_tz": "2017-01-10T17:22:40.000+01:00",
                "date_utc": "2017-01-10T16:22:40.000Z",
                "log_type": 2,
                "name": "Browse by brand",
                "detail": "detail"
            }
        ],
        "item_count": 2,
        "total_items": 4838,
        "total_pages": 2419,
        "navigation": {
            "next": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/events?since_date=2017-01-01 00:00:00 UTC&until_date=2019-01-30 00:00:00 UTC&fields=event_id,log_type,name,date_utc,date_tz,user_id,device_id,session_id,detail,item_count&page=2&per_page=2",
            "last": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/events?since_date=2017-01-01 00:00:00 UTC&until_date=2019-01-30 00:00:00 UTC&fields=event_id,log_type,name,date_utc,date_tz,user_id,device_id,session_id,detail,item_count&page=2419&per_page=2"
        }
    }   
}

Status: 400 bad request

{
    "success": false,
    "status": "bad_request",
    "error_message": "Wrong date format"
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "App not found"
}

Device events

GET /api/apps/app_identifier/devices/device_identifier/events?page=page&per_page=per_page&fields=fields&since_date=since_date&until_date=until_date&user_ids=user_ids&session_ids=session_ids...

Get all mobile events performed on an app for a list of devices specified. You can fetch starting from a given date, and filter by user or device identifiers.

All custom events are returned, along with the EnteringBackground and EnteringBackground which can help you identify the time spent in the app.

Query parameters

Property Type Description Default
app_identifier string The app unique identifier required
device_identifier string The device unique identifier required
page integer The page of events to retrieve. Negative values will be ignored, and the default number will be used. 1
per_page integer The number of device ids to retrieve per page.
Range of values accepted is [1..10000]. Values outside of range are ignored, and the default value is used instead.		 1000
fields string A string with a list of event fields to present, separated by commas. For possible fields to request, see Response fields below. If there's no value for some field requested, the value null is returned for that field.
 -
since_date datetime The date in UTC since when events should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
until_date datetime The date in UTC until when events should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
user_ids String A string with a list of user_ids to filter by, separated by commas. -
session_ids String A string with a list of session_idss to filter by, separated by commas. -
names String A string with a list of event names to filter by, separated by commas. -
details String A string with a list of event detail strings to filter by, separated by commas. -
group Boolean Allows to count the number of occurrences for the fields selected with the fields parameter. When grouping is activated, since_date has the default and maximum value of 60 days ago, or 60 days to until_date -

Response fields

Value Type Description
event_id string Always returned unless grouped results Unique identifier of the event
log_type integer Type of the log. 1 logs are errors, 2 logs are events, and 3 is used for background transition events
name string Name of the event as it was tagged in the app using the SDK
date_utc datetime Date and time of the event in UTC
date_tz datetime Date and time of the event in the time zone of the mobile device
user_id string Identifier of the user logged in when the event happened on the device
device_id string Unique identifier of the device on which the event occurred
session_id string Unique identifier of the session in which the event occurred
detail string or map Context associated to the event when it was recorded
count integer Always returned when grouped results number of occurrences of the returned fields over the period.

Response

Status: 200 OK

{
    "success": true,
    "result": {
        "items": [
            {
                "event_id": "39407325-1484066284-logs-00003",
                "session_id": "39407325-1484066284",
                "user_id": "user@gmail.com",
                "device_id": "f73314639d94f84f",
                "date_tz": "2017-01-10T17:22:40.000+01:00",
                "date_utc": "2017-01-10T16:22:40.000Z",
                "log_type": 2,
                "name": "Purchase product",
                "detail": {
                    "category": "shoes",
                    "price": 300,
                    "brand": "brand"                
                }
            },    
            {
                "event_id": "41674959-1486720502-logs-00003",
                "session_id": "41674959-1486720502",
                "user_id": "john@thebuyer.com",
                "device_id": "f73314639d94f84f",
                "date_tz": "2017-01-10T17:22:40.000+01:00",
                "date_utc": "2017-01-10T16:22:40.000Z",
                "log_type": 2,
                "name": "Browse by brand",
                "detail": "detail"
            }
        ],
        "item_count": 2,
        "total_items": 4838,
        "total_pages": 2419,
        "navigation": {
            "next": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/events?since_date=2017-01-01 00:00:00 UTC&until_date=2019-01-30 00:00:00 UTC&fields=event_id,log_type,name,date_utc,date_tz,user_id,device_id,session_id,detail,item_count&page=2&per_page=2",
            "last": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/events?since_date=2017-01-01 00:00:00 UTC&until_date=2019-01-30 00:00:00 UTC&fields=event_id,log_type,name,date_utc,date_tz,user_id,device_id,session_id,detail,item_count&page=2419&per_page=2"
        }
    }    
}

Status: 400 bad request

{
    "success": false,
    "status": "bad_request",
    "error_message": "Wrong date format"
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "User not found"
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "Device not found"
}

User events

GET /api/users/user_id/events?page=page&per_page=per_page&fields=fields&since_date=since_date&until_date=until_date&device_ids=device_ids&application_ids=application_ids&session_ids=session_ids...

Get all mobile events performed on an app. You can fetch starting from a given date, and filter by user or device identifiers.

All custom events are returned, along with the EnteringBackground and EnteringBackground which can help you identify the time spent in the app.

Query parameters

Property Type Description Default
user_id string The user for which you are requesting the list of events required
page integer The page of events to retrieve. Negative values will be ignored, and the default number will be used. 1
per_page integer The number of device ids to retrieve per page.
Range of values accepted is [1..10000]. Values outside of range are ignored, and the default value is used instead.		 1000
fields string A string with a list of event fields to present, separated by commas. For possible fields to request, see Response fields below. If there's no value for some field requested, the value null is returned for that field.
 -
since_date datetime The date in UTC since when events should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
until_date datetime The date in UTC until when events should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
device_ids String A string with a list of device_ids to filter by, separated by commas. -
application_ids String A string with a list of app identifiers to filter by, separated by commas. -
session_ids String A string with a list of session_idss to filter by, separated by commas. -
names String A string with a list of event names to filter by, separated by commas. -
details String A string with a list of event detail strings to filter by, separated by commas. -
group Boolean Allows to count the number of occurrences for the fields selected with the fields parameter. When grouping is activated, since_date has the default and maximum value of 60 days ago. -

Response fields

Value Type Description
event_id string Always returned unless grouped results Unique identifier of the event
log_type integer Type of the log. 1 logs are errors, 2 logs are events, and 3 is used for background transition events
name string Name of the event as it was tagged in the app using the SDK
date_utc datetime Date and time of the event in UTC
date_tz datetime Date and time of the event in the time zone of the mobile device
user_id string Identifier of the user logged in when the event happened on the device
device_id string Unique identifier of the device on which the event occurred
session_id string Unique identifier of the session in which the event occurred
detail string or map Context associated to the event when it was recorded
count integer Always returned when grouped results number of occurrences of the returned fields over the period.

Response

Status: 200 OK

{
    "success": true,
    "result": {
        "items": [
            {
                "event_id": "39407325-1484066284-logs-00003",
                "session_id": "39407325-1484066284",
                "user_id": "user@gmail.com",
                "device_id": "f73314639d94f84f",
                "date_tz": "2017-01-10T17:22:40.000+01:00",
                "date_utc": "2017-01-10T16:22:40.000Z",
                "log_type": 2,
                "name": "Purchase product",
                "detail": {
                    "category": "shoes",
                    "price": 300,
                    "brand": "brand"                
                }
            },    
            {
                "event_id": "41674959-1486720502-logs-00003",
                "session_id": "41674959-1486720502",
                "user_id": "user@gmail.com",
                "device_id": "f73314639d94f84f",
                "date_tz": "2017-01-10T17:22:40.000+01:00",
                "date_utc": "2017-01-10T16:22:40.000Z",
                "log_type": 2,
                "name": "Browse by brand",
                "detail": "detail"
            }
        ],
        "item_count": 2,
        "total_items": 4838,
        "total_pages": 2419,
        "navigation": {
            "next": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/events?since_date=2017-01-01 00:00:00 UTC&until_date=2019-01-30 00:00:00 UTC&fields=event_id,log_type,name,date_utc,date_tz,user_id,device_id,session_id,detail,item_count&page=2&per_page=2",
            "last": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/events?since_date=2017-01-01 00:00:00 UTC&until_date=2019-01-30 00:00:00 UTC&fields=event_id,log_type,name,date_utc,date_tz,user_id,device_id,session_id,detail,item_count&page=2419&per_page=2"
        }
    }
}

Status: 400 bad request

{
    "success": false,
    "status": "bad_request",
    "error_message": "Wrong date format"
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "User not found"
}

Sessions

App sessions

GET /api/apps/app_identifier/sessions?page=page&per_page=per_page&fields=fields&since_date=since_date&until_date=until_date&device_ids=device_ids&user_ids=user_ids&app_versions=app_versions&countries=countries&langs=langs

Export endpoint (see how to use it here):

GET /api/apps/app_identifier/sessions_export?fields=fields&since_date=since_date&until_date=until_date&device_ids=device_ids&user_ids=user_ids&app_versions=app_versions&countries=countries&langs=langs

Retrieve all sessions for a given app. Can be filtered by many fields including the device, user, country, app version, and more.

Query parameters

Property Type Description Default
app_identifier string The app unique identifier required
page integer The page of devices to retrieve. Negative values will be ignored, and the default number will be used. 1
per_page     integer   The number of device ids to retrieve per page.
Range of values accepted is [1..10000]. Values outside of range are ignored, and the default value is used instead.  		 1000
fields string A string with a list of event fields to present, separated by commas. For possible fields to request, see Response fields below. If there's no value for some field requested, the value null is returned for that field.
 -
since_date datetime The date in UTC since when sessions should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
until_date datetime The date in UTC until when sessions should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
device_ids String A string with a list of device_ids to filter by, separated by commas. -
user_ids String A string with a list of user_ids to filter by, separated by commas. -
app_versions String A string with a list of app version numbers to filter by, separated by commas. -
countries String A string with a list of country isocodes to filter by, separated by commas. -
langs String A string with a list of language isocodes to filter by, separated by commas. -

Response fields

Value Type Description
session_id string Always returned Unique identifier of the session
application_id string Unique identifier of the application on which the session occurred
device_id string Unique identifier of the device on which the session occurred
user_id string Unique identifier of the user logged in on the device when the session occurred
app_version string Version number of the app that was running when the session occurred
sdk_version string Version of the SDK used to record the session
os_version string Version of the OS running on the device when the session occurred
start_date_utc datetime Date and time when the session started, in UTC
start_date_tz datetime Date and time when the session started in the time zone of the mobile device
end_date_utc datetime Date and time when the session ended in UTC
end_date_tz datetime Date and time when the session ended in the time zone of the mobile device
duration integer Duration of the session in seconds. Only counts the time spent in foreground
timezone integer Offset from UTC representing the timezone of the device during the session
timeout integer Maximum time, in second, that occurred out of the app during the session. When this threshold is met, the session is automatically closed
device_type string Brand or family of device running the session
device_model string Precise model of the device that ran the session
idiom string Family of device running the session: pad, tablet, watch-app, wearable or phone
country string 2-char isocode of the country from where the session occurred
lang string 2-char or 3-char isocode of the language the device was set to when the session occurred
carrier string Carrier operating on the device during the session

Response

Status: 200 OK

{
    "success": true,
    "result": {
        "items": [
            {
                "session_id": "734769250-1504260285",
                "application_id": "FAAPPLI_0VDvABC",
                "app_version": "5.0.8",
                "sdk_version": "5.0.8",
                "os_version": "6.0",
                "user_id": null,
                "device_id": "af45975153b090c8",
                "start_date_utc": "2017-09-01T09:41:48.000Z",
                "end_date_utc": "2017-09-01T09:41:48.000Z",
                "timezone": "7200",
                "duration": "0",
                "device_model": "F3311",
                "device_type": "Sony",
                "idiom": "phone",
                "country": "FR",
                "lang": "en",
                "carrier": "Unknown"
            },
            {
                "session_id": "734769250-1504260285",
                "application_id": "FAAPPLI_0VDvABC",
                "app_version": "4.1.0",
                "sdk_version": "5.1.1-SNAPSHOT",
                "os_version": "6.0.1",
                "user_id": "user@gmail.com",
                "device_id": "af45975153b090c8",
                "start_date_utc": "2017-09-01T09:41:48.000Z",
                "end_date_utc": "2017-09-01T09:41:48.000Z",
                "timezone": "7200",
                "duration": "0",
                "device_model": "J82AP",
                "device_type": "iPad5,4",
                "idiom": "pad",
                "country": "US",
                "lang": "en",
                "carrier": "Unknown"
            }
        ],
        "item_count": 2,
        "total_items": 331,
        "total_pages": 166,
        "navigation": {
            "next": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/sessions?since_date=2017-09-01 00:00:00 UTC&until_date=2019-01-07 00:00:00 UTC&&&fields=session_id,application_id,device_id,user_id,app_version,sdk_version,os_version,start_date_utc,start_date_tz,end_date_utc,end_date_tz,duration,timezone,timeout,device_type,device_model,idiom,country,lang,carrier&page=2&per_page=2",
            "last": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/sessions?since_date=2017-09-01 00:00:00 UTC&until_date=2019-01-07 00:00:00 UTC&&&fields=session_id,application_id,device_id,user_id,app_version,sdk_version,os_version,start_date_utc,start_date_tz,end_date_utc,end_date_tz,duration,timezone,timeout,device_type,device_model,idiom,country,lang,carrier&page=166&per_page=2"
        }
    }
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "App not found"
}

Device sessions

GET /api/apps/app_identifier/devices/device_identifier/sessions?page=page&per_page=per_page&fields=fields&since_date=since_date&until_date=until_date&user_ids=user_ids&app_versions=app_versions&countries=countries&langs=langs

Retrieves all the sessions of a given device for a given app. This list can be filtered in many ways, including by country, user, app version, and more.

Query parameters

Property Type Description Default
app_identifier string The app unique identifier required
device_identifier string The device unique identifier required
page integer The page of devices to retrieve. Negative values will be ignored, and the default number will be used. 1
per_page     integer   The number of device ids to retrieve per page.
Range of values accepted is [1..10000]. Values outside of range are ignored, and the default value is used instead.  		 1000
fields string A string with a list of event fields to present, separated by commas. For possible fields to request, see Response fields below. If there's no value for some field requested, the value null is returned for that field.
 -
since_date datetime The date in UTC since when sessions should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
until_date datetime The date in UTC until when sessions should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
user_ids String A string with a list of user_ids to filter by, separated by commas. -
app_versions String A string with a list of app version numbers to filter by, separated by commas. -
countries String A string with a list of country isocodes to filter by, separated by commas. -
langs String A string with a list of language isocodes to filter by, separated by commas. -

Response fields

Value Type Description
session_id string Always returned Unique identifier of the session
application_id string Unique identifier of the application on which the session occurred
device_id string Unique identifier of the device on which the session occurred
user_id string Unique identifier of the user logged in on the device when the session occurred
app_version string Version number of the app that was running when the session occurred
sdk_version string Version of the SDK used to record the session
os_version string Version of the OS running on the device when the session occurred
start_date_utc datetime Date and time when the session started, in UTC
start_date_tz datetime Date and time when the session started in the time zone of the mobile device
end_date_utc datetime Date and time when the session ended in UTC
end_date_tz datetime Date and time when the session ended in the time zone of the mobile device
duration integer Duration of the session in seconds. Only counts the time spent in foreground
timezone integer Offset from UTC representing the timezone of the device during the session
timeout integer Maximum time, in second, that occurred out of the app during the session. When this threshold is met, the session is automatically closed
device_type string Brand or family of device running the session
device_model string Precise model of the device that ran the session
idiom string Family of device running the session: pad, tablet, watch-app, wearable or phone
country string 2-char isocode of the country from where the session occurred
lang string 2-char or 3-char isocode of the language the device was set to when the session occurred
carrier string Carrier operating on the device during the session

Response

Status: 200 OK

{
    "success": true,
    "result": {
        "items": [
            {
                "session_id": "734258360-1504256545",
                "application_id": "FAAPPLI_0VDvABC",
                "app_version": "4.1.0",
                "sdk_version": "5.1.1-SNAPSHOT",
                "os_version": "6.0.1",
                "user_id": "user@gmail.com",
                "device_id": "2ce7a1968a17779f",
                "start_date_utc": "2017-09-01T09:02:24.000Z",
                "end_date_utc": "2017-09-01T09:02:24.000Z",
                "timezone": "7200",
                "duration": "0",
                "device_model": "A0001",
                "device_type": "OnePlus",
                "idiom": "phone",
                "country": "FR",
                "lang": "fr",
                "carrier": "Unknown"
            },
            {
                "session_id": "734731798-1504260041",
                "application_id": "FAAPPLI_0VDvABC",
                "app_version": "4.1.0",
                "sdk_version": "5.1.1-SNAPSHOT",
                "os_version": "6.0.1",
                "user_id": "user@gmail.com",
                "device_id": "2ce7a1968a17779f",
                "start_date_utc": "2017-09-01T10:00:40.000Z",
                "end_date_utc": "2017-09-01T10:00:40.000Z",
                "timezone": "7200",
                "duration": "0",
                "device_model": "A0001",
                "device_type": "OnePlus",
                "idiom": "phone",
                "country": "FR",
                "lang": "fr",
                "carrier": "Unknown"
            }
        ],
        "item_count": 2,
        "total_items": 331,
        "total_pages": 166,
        "navigation": {
            "next": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/devices/2ce7a1968a17779f/sessions?since_date=2017-09-01 00:00:00 UTC&until_date=2019-01-07 00:00:00 UTC&fields=session_id,application_id,device_id,user_id,app_version,sdk_version,os_version,start_date_utc,start_date_tz,end_date_utc,end_date_tz,duration,timezone,timeout,device_type,device_model,idiom,country,lang,carrier&page=2&per_page=10",
            "last": "https://api.follow-apps.com/api/apps/FAAPPLI_0VDvABC/devices/2ce7a1968a17779f/sessions?since_date=2017-09-01 00:00:00 UTC&until_date=2019-01-07 00:00:00 UTC&fields=session_id,application_id,device_id,user_id,app_version,sdk_version,os_version,start_date_utc,start_date_tz,end_date_utc,end_date_tz,duration,timezone,timeout,device_type,device_model,idiom,country,lang,carrier&page=935&per_page=10"
        }
    }
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "App not found"
}

User sessions

GET /api/users/user_id/sessions?page=page&per_page=per_page&fields=fields&since_date=since_date&since_date=since_date&device_ids=device_ids&app_versions=app_versions&countries=countries&langs=langs&application_ids=application_ids

Retrieves all the sessions of a given device for a given app. This list can be filtered in many ways, including by country, user, app version, and more.

Query parameters

Property Type Description Default
user_id string The user unique identifier as set using the mobile SDK required
page integer The page of devices to retrieve. Negative values will be ignored, and the default number will be used. 1
per_page     integer   The number of device ids to retrieve per page.
Range of values accepted is [1..10000]. Values outside of range are ignored, and the default value is used instead.  		 1000
fields string A string with a list of event fields to present, separated by commas. For possible fields to request, see Response fields below. If there's no value for some field requested, the value null is returned for that field.
 -
since_date datetime The date in UTC since when sessions should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
until_date datetime The date in UTC until when sessions should be fetched. Expressed in any ISO format, e.g. 2017-04-06T16:41:44+05:00 -
device_ids String A string with a list of device_ids to filter by, separated by commas. -
app_versions String A string with a list of app version numbers to filter by, separated by commas. -
countries String A string with a list of country isocodes to filter by, separated by commas. -
langs String A string with a list of language isocodes to filter by, separated by commas. -
application_ids String A string with a list of app identifiers to filter by, separated by commas. -

Response fields

Value Type Description
session_id string Always returned Unique identifier of the session
application_id string Unique identifier of the application on which the session occurred
device_id string Unique identifier of the device on which the session occurred
user_id string Unique identifier of the user logged in on the device when the session occurred
app_version string Version number of the app that was running when the session occurred
sdk_version string Version of the SDK used to record the session
os_version string Version of the OS running on the device when the session occurred
start_date_utc datetime Date and time when the session started, in UTC
start_date_tz datetime Date and time when the session started in the time zone of the mobile device
end_date_utc datetime Date and time when the session ended in UTC
end_date_tz datetime Date and time when the session ended in the time zone of the mobile device
duration integer Duration of the session in seconds. Only counts the time spent in foreground
timezone integer Offset from UTC representing the timezone of the device during the session
timeout integer Maximum time, in second, that occurred out of the app during the session. When this threshold is met, the session is automatically closed
device_type string Brand or family of device running the session
device_model string Precise model of the device that ran the session
idiom string Family of device running the session: pad, tablet, watch-app, wearable or phone
country string 2-char isocode of the country from where the session occurred
lang string 2-char or 3-char isocode of the language the device was set to when the session occurred
carrier string Carrier operating on the device during the session

Response

Status: 200 OK

{
    "success": true,
    "result": {
        "items": [
        {
            "session_id": "889318178-1505742022",
            "application_id": "FAAPPLI_0VDvABC",
            "app_version": "5.0.8",
            "sdk_version": "5.0.8",
            "os_version": "8.0.0",
            "user_id": "user_test",
            "device_id": "3d515946269a0f24",
            "start_date_utc": "2017-09-18T13:40:22.000Z",
            "end_date_utc": "2017-09-18T13:43:08.000Z",
            "timezone": "7200",
            "duration": "20",
            "device_model": "Nexus 5X",
            "device_type": "LGE",
            "idiom": "phone",
            "country": "FR",
            "lang": "fr",
            "carrier": "Bouygues Telecom"
        },
        {
            "session_id": "889335902-1505742192",
            "application_id": "FAAPPLI_0VDvABC",
            "app_version": "5.0.8",
            "sdk_version": "5.0.8",
            "os_version": "8.0.0",
            "user_id": "user_test",
            "device_id": "3d515946269a0f24",
            "start_date_utc": "2017-09-18T13:43:09.000Z",
            "end_date_utc": "2017-09-18T13:43:28.000Z",
            "timezone": "7200",
            "duration": "4",
            "device_model": "Nexus 5X",
            "device_type": "LGE",
            "idiom": "phone",
            "country": "FR",
            "lang": "fr",
            "carrier": "Bouygues Telecom"
        }
    ],
        "item_count": 2,
        "total_items": 331,
        "total_pages": 166,
        "navigation": {
            "next": "https://api.follow-apps.com/api/users/user_test/sessions?since_date=2017-09-01 00:00:00 UTC&until_date=2019-01-07 00:00:00 UTC&fields=session_id,application_id,device_id,user_id,app_version,sdk_version,os_version,start_date_utc,start_date_tz,end_date_utc,end_date_tz,duration,timezone,timeout,device_type,device_model,idiom,country,lang,carrier&page=2&per_page=2",
            "last": "https://api.follow-apps.com/api/users/user_test/sessions?since_date=2017-09-01 00:00:00 UTC&until_date=2019-01-07 00:00:00 UTC&fields=session_id,application_id,device_id,user_id,app_version,sdk_version,os_version,start_date_utc,start_date_tz,end_date_utc,end_date_tz,duration,timezone,timeout,device_type,device_model,idiom,country,lang,carrier&page=166&per_page=2"
        }
    }
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "App not found"
}

Status: 404 not found

{
    "success": false,
    "status": "not_found",
    "error_message": "User not found"
}