Version : v1
BasePath : /
application/json
application/json
Create a crash report
Name : data
Flags : required
Type : CrashReport
HTTP Code | Description | Schema |
---|---|---|
201 | The crash report has been successfully created. | CreateCrashreportResponseSchema |
400 | Invalid input. | No Content |
404 | No device with the given uuid could be found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/crashreports/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
{ "device_local_id" : 0 }
List crash reports
Type | Name | Description | Schema |
---|---|---|---|
Query | build_fingerprint optional | string | |
Query | device optional | string | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | radio_version optional | string |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[crashreport](#crashreport)" ] | < CrashReport > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/crashreports/
"object"
Get a crash report
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this crashreport. | integer |
HTTP Code | Description | Schema |
---|---|---|
200 | CrashReport | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/crashreports/0/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
Update a crash report
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this crashreport. | integer |
Name : data
Flags : required
Type : CrashReport
HTTP Code | Description | Schema |
---|---|---|
200 | CrashReport | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/crashreports/0/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
Delete a crash report
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this crashreport. | integer |
HTTP Code | Description | Schema |
---|---|---|
204 | No Content | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/crashreports/0/
Partially update a crash report
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this crashreport. | integer |
Name : data
Flags : required
Type : CrashReport
HTTP Code | Description | Schema |
---|---|---|
200 | CrashReport | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/crashreports/0/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
Create a device
Name : data
Flags : required
Type : Device
HTTP Code | Description | Schema |
---|---|---|
201 | Device | |
400 | Invalid input. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/
{ "id" : 0, "board_date" : "string", "last_heartbeat" : "string", "uuid" : "string", "imei" : "string", "chipset" : "string", "token" : "string", "next_per_crashreport_key" : 0, "next_per_heartbeat_key" : 0, "user" : 0 }
{ "id" : 0, "board_date" : "string", "last_heartbeat" : "string", "uuid" : "string", "imei" : "string", "chipset" : "string", "token" : "string", "next_per_crashreport_key" : 0, "next_per_heartbeat_key" : 0, "user" : 0 }
List devices
Type | Name | Description | Schema |
---|---|---|---|
Query | board_date optional | string | |
Query | chipset optional | string | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | uuid optional | string |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[device](#device)" ] | < Device > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/
"object"
Register a new device.
This endpoint will generate a django user for the new device. The device is identified by a uuid, and authenticated with a token. We generate the uuid here as this makes it easier to deal with collisions.
Name : data
Flags : required
Type : DeviceCreate
HTTP Code | Description | Schema |
---|---|---|
200 | The device has been successfully registered. | DeviceRegisterResponseSchema |
400 | Invalid input. | No Content |
/hiccup/api/v1/devices/register/
{ "board_date" : "string", "chipset" : "string" }
{ "uuid" : "string", "token" : "string" }
Get a crash report
Type | Name | Schema |
---|---|---|
Path | device__uuid required | string |
Path | device_local_id required | integer |
HTTP Code | Description | Schema |
---|---|---|
200 | CrashReport | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/crashreports/0/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
Update a crash report
Type | Name | Schema |
---|---|---|
Path | device__uuid required | string |
Path | device_local_id required | integer |
Name : data
Flags : required
Type : CrashReport
HTTP Code | Description | Schema |
---|---|---|
200 | CrashReport | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/crashreports/0/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
Delete a crash report
Type | Name | Schema |
---|---|---|
Path | device__uuid required | string |
Path | device_local_id required | integer |
HTTP Code | Description | Schema |
---|---|---|
204 | No Content | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/crashreports/0/
Partially update a crash report
Type | Name | Schema |
---|---|---|
Path | device__uuid required | string |
Path | device_local_id required | integer |
Name : data
Flags : required
Type : CrashReport
HTTP Code | Description | Schema |
---|---|---|
200 | CrashReport | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/crashreports/0/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
Get a device
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
HTTP Code | Description | Schema |
---|---|---|
200 | Device | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/
{ "id" : 0, "board_date" : "string", "last_heartbeat" : "string", "uuid" : "string", "imei" : "string", "chipset" : "string", "token" : "string", "next_per_crashreport_key" : 0, "next_per_heartbeat_key" : 0, "user" : 0 }
Update a device
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
Name : data
Flags : required
Type : Device
HTTP Code | Description | Schema |
---|---|---|
200 | Device | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/
{ "id" : 0, "board_date" : "string", "last_heartbeat" : "string", "uuid" : "string", "imei" : "string", "chipset" : "string", "token" : "string", "next_per_crashreport_key" : 0, "next_per_heartbeat_key" : 0, "user" : 0 }
{ "id" : 0, "board_date" : "string", "last_heartbeat" : "string", "uuid" : "string", "imei" : "string", "chipset" : "string", "token" : "string", "next_per_crashreport_key" : 0, "next_per_heartbeat_key" : 0, "user" : 0 }
Delete a device
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
HTTP Code | Description | Schema |
---|---|---|
204 | No Content | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/
Make a partial update for a device
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
Name : data
Flags : required
Type : Device
HTTP Code | Description | Schema |
---|---|---|
200 | Device | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/
{ "id" : 0, "board_date" : "string", "last_heartbeat" : "string", "uuid" : "string", "imei" : "string", "chipset" : "string", "token" : "string", "next_per_crashreport_key" : 0, "next_per_heartbeat_key" : 0, "user" : 0 }
{ "id" : 0, "board_date" : "string", "last_heartbeat" : "string", "uuid" : "string", "imei" : "string", "chipset" : "string", "token" : "string", "next_per_crashreport_key" : 0, "next_per_heartbeat_key" : 0, "user" : 0 }
Create a crash report
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
Name : data
Flags : required
Type : CrashReport
HTTP Code | Description | Schema |
---|---|---|
201 | The crash report has been successfully created. | CreateCrashreportResponseSchema |
400 | Invalid input. | No Content |
404 | No device with the given uuid could be found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/crashreports/
{ "id" : "string", "logfiles" : [ "string" ], "uuid" : "string", "device_local_id" : 0, "date" : "string", "is_fake_report" : true, "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "boot_reason" : "string", "power_on_reason" : "string", "power_off_reason" : "string", "next_logfile_key" : 0, "created_at" : "string" }
{ "device_local_id" : 0 }
List crash reports
Type | Name | Description | Schema |
---|---|---|---|
Path | uuid required | string | |
Query | build_fingerprint optional | string | |
Query | device optional | string | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | radio_version optional | string |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[crashreport](#crashreport)" ] | < CrashReport > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/crashreports/
"object"
Upload a log file for a crash report.
Type | Name | Schema |
---|---|---|
Path | device_local_id required | string |
Path | filename required | string |
Path | uuid required | string |
Name : data
Flags : required
Type : LogFile
HTTP Code | Description | Schema |
---|---|---|
201 | Created | No Content |
400 | Invalid input. | No Content |
404 | Crashreport does not exist. | No Content |
\*/*
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/crashreports/string/logfile_put/string/
{ "id" : 0, "logfile_type" : "string", "logfile" : "string", "crashreport_local_id" : 0, "created_at" : "string", "crashreport" : 0 }
Create a heartbeat
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
Name : data
Flags : required
Type : HeartBeat
HTTP Code | Description | Schema |
---|---|---|
201 | HeartBeat | |
400 | Invalid input. | No Content |
404 | No device with the given uuid could be found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/heartbeats/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
List heartbeats
Type | Name | Description | Schema |
---|---|---|---|
Path | uuid required | string | |
Query | build_fingerprint optional | string | |
Query | device optional | string | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | radio_version optional | string |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[heartbeat](#heartbeat)" ] | < HeartBeat > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/heartbeats/
"object"
Get a heartbeat
Type | Name | Schema |
---|---|---|
Path | device_local_id required | integer |
Path | uuid required | string |
HTTP Code | Description | Schema |
---|---|---|
200 | HeartBeat | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/heartbeats/0/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
Update a heartbeat
Type | Name | Schema |
---|---|---|
Path | device_local_id required | integer |
Path | uuid required | string |
Name : data
Flags : required
Type : HeartBeat
HTTP Code | Description | Schema |
---|---|---|
200 | HeartBeat | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/heartbeats/0/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
Delete a heartbeat
Type | Name | Schema |
---|---|---|
Path | device_local_id required | integer |
Path | uuid required | string |
HTTP Code | Description | Schema |
---|---|---|
204 | No Content | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/heartbeats/0/
Partially update a heartbeat
Type | Name | Schema |
---|---|---|
Path | device_local_id required | integer |
Path | uuid required | string |
Name : data
Flags : required
Type : HeartBeat
HTTP Code | Description | Schema |
---|---|---|
200 | HeartBeat | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/devices/string/heartbeats/0/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
Create a heartbeat
Name : data
Flags : required
Type : HeartBeat
HTTP Code | Description | Schema |
---|---|---|
201 | HeartBeat | |
400 | Invalid input. | No Content |
404 | No device with the given uuid could be found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/heartbeats/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
List heartbeats
Type | Name | Description | Schema |
---|---|---|---|
Query | build_fingerprint optional | string | |
Query | device optional | string | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | radio_version optional | string |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[heartbeat](#heartbeat)" ] | < HeartBeat > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/heartbeats/
"object"
Get a heartbeat
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this heart beat. | integer |
HTTP Code | Description | Schema |
---|---|---|
200 | HeartBeat | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/heartbeats/0/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
Update a heartbeat
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this heart beat. | integer |
Name : data
Flags : required
Type : HeartBeat
HTTP Code | Description | Schema |
---|---|---|
200 | HeartBeat | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/heartbeats/0/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
Delete a heartbeat
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this heart beat. | integer |
HTTP Code | Description | Schema |
---|---|---|
204 | No Content | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/heartbeats/0/
Partially update a heartbeat
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this heart beat. | integer |
Name : data
Flags : required
Type : HeartBeat
HTTP Code | Description | Schema |
---|---|---|
200 | HeartBeat | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/heartbeats/0/
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
{ "id" : "string", "uuid" : "string", "device_local_id" : 0, "date" : "string", "app_version" : 0, "uptime" : "string", "build_fingerprint" : "string", "radio_version" : "string", "created_at" : "string" }
List log files
Type | Name | Description | Schema |
---|---|---|---|
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[logfile](#logfile)" ] | < LogFile > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/logfiles/
"object"
Get a log file
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this log file. | integer |
HTTP Code | Description | Schema |
---|---|---|
200 | LogFile | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/logfiles/0/
{ "id" : 0, "logfile_type" : "string", "logfile" : "string", "crashreport_local_id" : 0, "created_at" : "string", "crashreport" : 0 }
Update a log file
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this log file. | integer |
Name : data
Flags : required
Type : LogFile
HTTP Code | Description | Schema |
---|---|---|
200 | LogFile | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/logfiles/0/
{ "id" : 0, "logfile_type" : "string", "logfile" : "string", "crashreport_local_id" : 0, "created_at" : "string", "crashreport" : 0 }
{ "id" : 0, "logfile_type" : "string", "logfile" : "string", "crashreport_local_id" : 0, "created_at" : "string", "crashreport" : 0 }
Delete a log file
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this log file. | integer |
HTTP Code | Description | Schema |
---|---|---|
204 | No Content | |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/logfiles/0/
Partially update a log file
Type | Name | Description | Schema |
---|---|---|---|
Path | id required | A unique integer value identifying this log file. | integer |
Name : data
Flags : required
Type : LogFile
HTTP Code | Description | Schema |
---|---|---|
200 | LogFile | |
400 | Invalid input. | No Content |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup/api/v1/logfiles/0/
{ "id" : 0, "logfile_type" : "string", "logfile" : "string", "crashreport_local_id" : 0, "created_at" : "string", "crashreport" : 0 }
{ "id" : 0, "logfile_type" : "string", "logfile" : "string", "crashreport_local_id" : 0, "created_at" : "string", "crashreport" : 0 }
Get some general statistics for a device.
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | DeviceStatOverview |
404 | Not found. | No Content |
Name | Description | Schema |
---|---|---|
board_date optional | Example : "string" | string |
crashes_per_day optional | Example : 0.0 | number |
crashreports optional | Example : 0 | integer |
heartbeats optional | Example : 0 | integer |
last_active optional | Example : "string" | string |
smpl_per_day optional | Example : 0.0 | number |
smpls optional | Example : 0 | integer |
uuid optional | Example : "string" | string |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup_stats/api/v1/device_overview/string/
"object"
Get the report history of a device
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | < DeviceReportHistoryEntry > array |
404 | Not found. | No Content |
Name | Description | Schema |
---|---|---|
date optional | Example : "string" | string |
heartbeats optional | Example : 0 | integer |
other optional | Example : 0 | integer |
prob_crashes optional | Example : 0 | integer |
smpl optional | Example : 0 | integer |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup_stats/api/v1/device_report_history/string/
[ "object" ]
Get the update history of a device
Type | Name | Schema |
---|---|---|
Path | uuid required | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | < DeviceUpdateHistoryEntry > array |
404 | Not found. | No Content |
Name | Description | Schema |
---|---|---|
build_fingerprint optional | Example : "string" | string |
heartbeats optional | Example : 0 | integer |
max optional | Example : 0 | integer |
other optional | Example : 0 | integer |
prob_crashes optional | Example : 0 | integer |
smpl optional | Example : 0 | integer |
update_date optional | Example : "string" | string |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup_stats/api/v1/device_update_history/string/
[ "object" ]
Get a log file.
Type | Name | Schema |
---|---|---|
Path | id required | string |
HTTP Code | Description | Schema |
---|---|---|
200 | OK | file |
404 | Not found. | No Content |
Type | Name |
---|---|
oauth2 | Google OAuth |
apiKey | Device token authentication |
/hiccup_stats/api/v1/logfile_download/string/
"file"
View for listing RadioVersionDaily instances.
Type | Name | Description | Schema |
---|---|---|---|
Query | date optional | string | |
Query | date_end optional | string | |
Query | date_start optional | string | |
Query | heartbeats optional | number | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | other optional | number | |
Query | prob_crashes optional | number | |
Query | smpl optional | number | |
Query | version optional | string | |
Query | version__is_beta_release optional | string | |
Query | version__is_official_release optional | string | |
Query | version__radio_version optional | string |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[radioversiondaily](#radioversiondaily)" ] | < RadioVersionDaily > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
/hiccup_stats/api/v1/radio_version_daily/
"object"
View for listing RadioVersion instances.
Type | Name | Description | Schema |
---|---|---|---|
Query | first_seen_after optional | string | |
Query | first_seen_before optional | string | |
Query | first_seen_on optional | string | |
Query | heartbeats optional | number | |
Query | is_beta_release optional | string | |
Query | is_official_release optional | string | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | other optional | number | |
Query | prob_crashes optional | number | |
Query | radio_version optional | string | |
Query | released_after optional | string | |
Query | released_before optional | string | |
Query | released_on optional | string | |
Query | smpl optional | number |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[radioversion](#radioversion)" ] | < RadioVersion > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
/hiccup_stats/api/v1/radio_versions/
"object"
Get the number of devices, crashreports and heartbeats
HTTP Code | Description | Schema |
---|---|---|
200 | OK | Status |
Name | Description | Schema |
---|---|---|
crashreports optional | Example : 0 | integer |
devices optional | Example : 0 | integer |
heartbeats optional | Example : 0 | integer |
Type | Name |
---|---|
oauth2 | Google OAuth |
/hiccup_stats/api/v1/status/
"object"
View for listing VersionDaily instances.
Type | Name | Description | Schema |
---|---|---|---|
Query | date optional | string | |
Query | date_end optional | string | |
Query | date_start optional | string | |
Query | heartbeats optional | number | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | other optional | number | |
Query | prob_crashes optional | number | |
Query | smpl optional | number | |
Query | version optional | string | |
Query | version__build_fingerprint optional | string | |
Query | version__is_beta_release optional | string | |
Query | version__is_official_release optional | string |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[versiondaily](#versiondaily)" ] | < VersionDaily > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
/hiccup_stats/api/v1/version_daily/
"object"
View for listing versions.
Type | Name | Description | Schema |
---|---|---|---|
Query | build_fingerprint optional | string | |
Query | first_seen_after optional | string | |
Query | first_seen_before optional | string | |
Query | first_seen_on optional | string | |
Query | heartbeats optional | number | |
Query | is_beta_release optional | string | |
Query | is_official_release optional | string | |
Query | limit optional | Number of results to return per page. | integer |
Query | offset optional | The initial index from which to return the results. | integer |
Query | other optional | number | |
Query | prob_crashes optional | number | |
Query | released_after optional | string | |
Query | released_before optional | string | |
Query | released_on optional | string | |
Query | smpl optional | number |
HTTP Code | Schema |
---|---|
200 | Response 200 |
Name | Description | Schema |
---|---|---|
count required | Example : 0 | integer |
next optional | Example : "string" | string (uri) |
previous optional | Example : "string" | string (uri) |
results required | Example : [ "[version](#version)" ] | < Version > array |
Type | Name |
---|---|
oauth2 | Google OAuth |
/hiccup_stats/api/v1/versions/
"object"
Name | Description | Schema |
---|---|---|
app_version required | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
boot_reason required | Length : 1 - 200 Example : "string" | string |
build_fingerprint required | Length : 1 - 200 Example : "string" | string |
created_at optional read-only | Example : "string" | string (date-time) |
date required | Example : "string" | string (date-time) |
device_local_id optional | Example : 0 | integer |
id optional read-only | Example : "string" | string |
is_fake_report optional | Example : true | boolean |
logfiles optional read-only | Example : [ "string" ] | < string (uri) > array |
next_logfile_key optional | Minimum value : 0 Maximum value : 2147483647 Example : 0 | integer |
power_off_reason required | Length : 1 - 200 Example : "string" | string |
power_on_reason required | Length : 1 - 200 Example : "string" | string |
radio_version optional | Length : 1 - 200 Example : "string" | string |
uptime required | Length : 1 - 200 Example : "string" | string |
uuid required | Length : 1 - 64 Example : "string" | string |
Name | Description | Schema |
---|---|---|
device_local_id optional | Example : 0 | integer |
Name | Description | Schema |
---|---|---|
board_date required | Example : "string" | string (date-time) |
chipset optional | Maximal length : 200 Example : "string" | string |
id optional read-only | Example : 0 | integer |
imei optional | Maximal length : 32 Example : "string" | string |
last_heartbeat required | Example : "string" | string (date-time) |
next_per_crashreport_key optional | Minimum value : 0 Maximum value : 2147483647 Example : 0 | integer |
next_per_heartbeat_key optional | Minimum value : 0 Maximum value : 2147483647 Example : 0 | integer |
token optional | Maximal length : 200 Example : "string" | string |
user required | Example : 0 | integer |
uuid optional read-only | Minimum length : 1 Example : "string" | string |
Name | Description | Schema |
---|---|---|
board_date required | Example : "string" | string (date-time) |
chipset required | Maximal length : 200 Example : "string" | string |
Name | Description | Schema |
---|---|---|
token optional | Maximal length : 200 Example : "string" | string |
uuid optional read-only | Minimum length : 1 Example : "string" | string |
Name | Description | Schema |
---|---|---|
app_version required | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
build_fingerprint required | Length : 1 - 200 Example : "string" | string |
created_at optional read-only | Example : "string" | string (date-time) |
date required | Example : "string" | string (date-time) |
device_local_id optional | Example : 0 | integer |
id optional read-only | Example : "string" | string |
radio_version optional | Length : 1 - 200 Example : "string" | string |
uptime required | Length : 1 - 200 Example : "string" | string |
uuid required | Length : 1 - 64 Example : "string" | string |
Name | Description | Schema |
---|---|---|
crashreport required | Example : 0 | integer |
crashreport_local_id optional | Minimum value : 0 Maximum value : 2147483647 Example : 0 | integer |
created_at optional read-only | Example : "string" | string (date-time) |
id optional read-only | Example : 0 | integer |
logfile optional read-only | Example : "string" | string (uri) |
logfile_type optional | Length : 1 - 36 Example : "string" | string |
Name | Description | Schema |
---|---|---|
first_seen_on required | Example : "string" | string (date) |
heartbeats optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
id optional read-only | Example : 0 | integer |
is_beta_release optional | Example : true | boolean |
is_official_release optional | Example : true | boolean |
other optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
prob_crashes optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
radio_version required | Length : 1 - 200 Example : "string" | string |
released_on required | Example : "string" | string (date) |
smpl optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
Name | Description | Schema |
---|---|---|
date required | Example : "string" | string (date) |
heartbeats optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
id optional read-only | Example : 0 | integer |
other optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
prob_crashes optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
radio_version required | Minimum length : 1 Example : "string" | string |
smpl optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
version required | Example : 0 | integer |
Name | Description | Schema |
---|---|---|
build_fingerprint required | Length : 1 - 200 Example : "string" | string |
first_seen_on required | Example : "string" | string (date) |
heartbeats optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
id optional read-only | Example : 0 | integer |
is_beta_release optional | Example : true | boolean |
is_official_release optional | Example : true | boolean |
other optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
prob_crashes optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
released_on required | Example : "string" | string (date) |
smpl optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
Name | Description | Schema |
---|---|---|
build_fingerprint required | Minimum length : 1 Example : "string" | string |
date required | Example : "string" | string (date) |
heartbeats optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
id optional read-only | Example : 0 | integer |
other optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
prob_crashes optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
smpl optional | Minimum value : -2147483648 Maximum value : 2147483647 Example : 0 | integer |
version required | Example : 0 | integer |
Authenticate using a token that was returned on successful registration of a new device. The token can only be used to authenticate requests that target the device with the matching UUID. The token has to be put in the request header: 'Authorization: Token <AUTH_TOKEN>'
Type : apiKey
Name : Authorization
In : HEADER
Authenticate using a Google account. Only E-mail addresses in the @fairphone.com domain are allowed.
Type : oauth2
Flow : implicit
Token URL : /accounts/google/login/callback/