Hiccup API

Overview

Version information

Version : v1

URI scheme

BasePath : /

Consumes

application/json

Produces

application/json

Paths

POST /hiccup/api/v1/crashreports/

Description

Create a crash report

Body parameter

Name : data
Flags : required
Type : CrashReport

Responses

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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/crashreports/

Request body

{
  "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"
}

Example HTTP response

Response 201

{
  "device_local_id" : 0
}

GET /hiccup/api/v1/crashreports/

Description

List crash reports

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/crashreports/

Example HTTP response

Response 200

"object"

GET /hiccup/api/v1/crashreports/{id}/

Description

Get a crash report

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this crashreport.	integer

Responses

HTTP Code	Description	Schema
200		CrashReport
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/crashreports/0/

Example HTTP response

Response 200

{
  "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"
}

PUT /hiccup/api/v1/crashreports/{id}/

Description

Update a crash report

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this crashreport.	integer

Body parameter

Name : data
Flags : required
Type : CrashReport

Responses

HTTP Code	Description	Schema
200		CrashReport
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/crashreports/0/

Request body

{
  "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"
}

Example HTTP response

Response 200

{
  "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 /hiccup/api/v1/crashreports/{id}/

Description

Delete a crash report

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this crashreport.	integer

Responses

HTTP Code	Description	Schema
204		No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/crashreports/0/

PATCH /hiccup/api/v1/crashreports/{id}/

Description

Partially update a crash report

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this crashreport.	integer

Body parameter

Name : data
Flags : required
Type : CrashReport

Responses

HTTP Code	Description	Schema
200		CrashReport
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/crashreports/0/

Request body

{
  "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"
}

Example HTTP response

Response 200

{
  "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"
}

POST /hiccup/api/v1/devices/

Description

Create a device

Body parameter

Name : data
Flags : required
Type : Device

Responses

HTTP Code	Description	Schema
201		Device
400	Invalid input.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/

Request body

{
  "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
}

Example HTTP response

Response 201

{
  "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
}

GET /hiccup/api/v1/devices/

Description

List devices

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/

Example HTTP response

Response 200

"object"

POST /hiccup/api/v1/devices/register/

Description

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.

Body parameter

Name : data
Flags : required
Type : DeviceCreate

Responses

HTTP Code	Description	Schema
200	The device has been successfully registered.	DeviceRegisterResponseSchema
400	Invalid input.	No Content

Example HTTP request

Request path

/hiccup/api/v1/devices/register/

Request body

{
  "board_date" : "string",
  "chipset" : "string"
}

Example HTTP response

Response 200

{
  "uuid" : "string",
  "token" : "string"
}

GET /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/

Description

Get a crash report

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	integer

Responses

HTTP Code	Description	Schema
200		CrashReport
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/crashreports/0/

Example HTTP response

Response 200

{
  "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"
}

PUT /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/

Description

Update a crash report

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	integer

Body parameter

Name : data
Flags : required
Type : CrashReport

Responses

HTTP Code	Description	Schema
200		CrashReport
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/crashreports/0/

Request body

{
  "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"
}

Example HTTP response

Response 200

{
  "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 /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/

Description

Delete a crash report

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	integer

Responses

HTTP Code	Description	Schema
204		No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/crashreports/0/

PATCH /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/

Description

Partially update a crash report

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	integer

Body parameter

Name : data
Flags : required
Type : CrashReport

Responses

HTTP Code	Description	Schema
200		CrashReport
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/crashreports/0/

Request body

{
  "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"
}

Example HTTP response

Response 200

{
  "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 /hiccup/api/v1/devices/{uuid}/

Description

Get a device

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Description	Schema
200		Device
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

Example HTTP response

Response 200

{
  "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
}

PUT /hiccup/api/v1/devices/{uuid}/

Description

Update a device

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : required
Type : Device

Responses

HTTP Code	Description	Schema
200		Device
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

Request body

{
  "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
}

Example HTTP response

Response 200

{
  "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 /hiccup/api/v1/devices/{uuid}/

Description

Delete a device

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Description	Schema
204		No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

PATCH /hiccup/api/v1/devices/{uuid}/

Description

Make a partial update for a device

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : required
Type : Device

Responses

HTTP Code	Description	Schema
200		Device
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

Request body

{
  "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
}

Example HTTP response

Response 200

{
  "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
}

POST /hiccup/api/v1/devices/{uuid}/crashreports/

Description

Create a crash report

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : required
Type : CrashReport

Responses

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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/crashreports/

Request body

{
  "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"
}

Example HTTP response

Response 201

{
  "device_local_id" : 0
}

GET /hiccup/api/v1/devices/{uuid}/crashreports/

Description

List crash reports

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/crashreports/

Example HTTP response

Response 200

"object"

POST /hiccup/api/v1/devices/{uuid}/crashreports/{device_local_id}/logfile_put/{filename}/

Description

Upload a log file for a crash report.

Parameters

Type	Name	Schema
Path	device_local_id required	string
Path	filename required	string
Path	uuid required	string

Body parameter

Name : data
Flags : required
Type : LogFile

Responses

HTTP Code	Description	Schema
201	Created	No Content
400	Invalid input.	No Content
404	Crashreport does not exist.	No Content

Consumes

\*/*

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/crashreports/string/logfile_put/string/

Request body

{
  "id" : 0,
  "logfile_type" : "string",
  "logfile" : "string",
  "crashreport_local_id" : 0,
  "created_at" : "string",
  "crashreport" : 0
}

POST /hiccup/api/v1/devices/{uuid}/heartbeats/

Description

Create a heartbeat

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : required
Type : HeartBeat

Responses

HTTP Code	Description	Schema
201		HeartBeat
400	Invalid input.	No Content
404	No device with the given uuid could be found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/heartbeats/

Request body

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

Example HTTP response

Response 201

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

GET /hiccup/api/v1/devices/{uuid}/heartbeats/

Description

List heartbeats

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/heartbeats/

Example HTTP response

Response 200

"object"

GET /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/

Description

Get a heartbeat

Parameters

Type	Name	Schema
Path	device_local_id required	integer
Path	uuid required	string

Responses

HTTP Code	Description	Schema
200		HeartBeat
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/heartbeats/0/

Example HTTP response

Response 200

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

PUT /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/

Description

Update a heartbeat

Parameters

Type	Name	Schema
Path	device_local_id required	integer
Path	uuid required	string

Body parameter

Name : data
Flags : required
Type : HeartBeat

Responses

HTTP Code	Description	Schema
200		HeartBeat
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/heartbeats/0/

Request body

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

Example HTTP response

Response 200

{
  "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 /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/

Description

Delete a heartbeat

Parameters

Type	Name	Schema
Path	device_local_id required	integer
Path	uuid required	string

Responses

HTTP Code	Description	Schema
204		No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/heartbeats/0/

PATCH /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/

Description

Partially update a heartbeat

Parameters

Type	Name	Schema
Path	device_local_id required	integer
Path	uuid required	string

Body parameter

Name : data
Flags : required
Type : HeartBeat

Responses

HTTP Code	Description	Schema
200		HeartBeat
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/devices/string/heartbeats/0/

Request body

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

Example HTTP response

Response 200

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

POST /hiccup/api/v1/heartbeats/

Description

Create a heartbeat

Body parameter

Name : data
Flags : required
Type : HeartBeat

Responses

HTTP Code	Description	Schema
201		HeartBeat
400	Invalid input.	No Content
404	No device with the given uuid could be found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/heartbeats/

Request body

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

Example HTTP response

Response 201

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

GET /hiccup/api/v1/heartbeats/

Description

List heartbeats

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/heartbeats/

Example HTTP response

Response 200

"object"

GET /hiccup/api/v1/heartbeats/{id}/

Description

Get a heartbeat

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this heart beat.	integer

Responses

HTTP Code	Description	Schema
200		HeartBeat
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/heartbeats/0/

Example HTTP response

Response 200

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

PUT /hiccup/api/v1/heartbeats/{id}/

Description

Update a heartbeat

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this heart beat.	integer

Body parameter

Name : data
Flags : required
Type : HeartBeat

Responses

HTTP Code	Description	Schema
200		HeartBeat
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/heartbeats/0/

Request body

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

Example HTTP response

Response 200

{
  "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 /hiccup/api/v1/heartbeats/{id}/

Description

Delete a heartbeat

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this heart beat.	integer

Responses

HTTP Code	Description	Schema
204		No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/heartbeats/0/

PATCH /hiccup/api/v1/heartbeats/{id}/

Description

Partially update a heartbeat

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this heart beat.	integer

Body parameter

Name : data
Flags : required
Type : HeartBeat

Responses

HTTP Code	Description	Schema
200		HeartBeat
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/heartbeats/0/

Request body

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

Example HTTP response

Response 200

{
  "id" : "string",
  "uuid" : "string",
  "device_local_id" : 0,
  "date" : "string",
  "app_version" : 0,
  "uptime" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "created_at" : "string"
}

GET /hiccup/api/v1/logfiles/

Description

List log files

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/logfiles/

Example HTTP response

Response 200

"object"

GET /hiccup/api/v1/logfiles/{id}/

Description

Get a log file

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this log file.	integer

Responses

HTTP Code	Description	Schema
200		LogFile
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/logfiles/0/

Example HTTP response

Response 200

{
  "id" : 0,
  "logfile_type" : "string",
  "logfile" : "string",
  "crashreport_local_id" : 0,
  "created_at" : "string",
  "crashreport" : 0
}

PUT /hiccup/api/v1/logfiles/{id}/

Description

Update a log file

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this log file.	integer

Body parameter

Name : data
Flags : required
Type : LogFile

Responses

HTTP Code	Description	Schema
200		LogFile
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/logfiles/0/

Request body

{
  "id" : 0,
  "logfile_type" : "string",
  "logfile" : "string",
  "crashreport_local_id" : 0,
  "created_at" : "string",
  "crashreport" : 0
}

Example HTTP response

Response 200

{
  "id" : 0,
  "logfile_type" : "string",
  "logfile" : "string",
  "crashreport_local_id" : 0,
  "created_at" : "string",
  "crashreport" : 0
}

DELETE /hiccup/api/v1/logfiles/{id}/

Description

Delete a log file

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this log file.	integer

Responses

HTTP Code	Description	Schema
204		No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/logfiles/0/

PATCH /hiccup/api/v1/logfiles/{id}/

Description

Partially update a log file

Parameters

Type	Name	Description	Schema
Path	id required	A unique integer value identifying this log file.	integer

Body parameter

Name : data
Flags : required
Type : LogFile

Responses

HTTP Code	Description	Schema
200		LogFile
400	Invalid input.	No Content
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup/api/v1/logfiles/0/

Request body

{
  "id" : 0,
  "logfile_type" : "string",
  "logfile" : "string",
  "crashreport_local_id" : 0,
  "created_at" : "string",
  "crashreport" : 0
}

Example HTTP response

Response 200

{
  "id" : 0,
  "logfile_type" : "string",
  "logfile" : "string",
  "crashreport_local_id" : 0,
  "created_at" : "string",
  "crashreport" : 0
}

GET /hiccup_stats/api/v1/device_overview/{uuid}/

Description

Get some general statistics for a device.

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Description	Schema
200	OK	DeviceStatOverview
404	Not found.	No Content

DeviceStatOverview

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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup_stats/api/v1/device_overview/string/

Example HTTP response

Response 200

"object"

GET /hiccup_stats/api/v1/device_report_history/{uuid}/

Description

Get the report history of a device

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Description	Schema
200	OK	< DeviceReportHistoryEntry > array
404	Not found.	No Content

DeviceReportHistoryEntry

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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup_stats/api/v1/device_report_history/string/

Example HTTP response

Response 200

[ "object" ]

GET /hiccup_stats/api/v1/device_update_history/{uuid}/

Description

Get the update history of a device

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Description	Schema
200	OK	< DeviceUpdateHistoryEntry > array
404	Not found.	No Content

DeviceUpdateHistoryEntry

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

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup_stats/api/v1/device_update_history/string/

Example HTTP response

Response 200

[ "object" ]

GET /hiccup_stats/api/v1/logfile_download/{id}/

Description

Get a log file.

Parameters

Type	Name	Schema
Path	id required	string

Responses

HTTP Code	Description	Schema
200	OK	file
404	Not found.	No Content

Security

Type	Name
oauth2	Google OAuth
apiKey	Device token authentication

Example HTTP request

Request path

/hiccup_stats/api/v1/logfile_download/string/

Example HTTP response

Response 200

"file"

GET /hiccup_stats/api/v1/radio_version_daily/

Description

View for listing RadioVersionDaily instances.

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth

Example HTTP request

Request path

/hiccup_stats/api/v1/radio_version_daily/

Example HTTP response

Response 200

"object"

GET /hiccup_stats/api/v1/radio_versions/

Description

View for listing RadioVersion instances.

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth

Example HTTP request

Request path

/hiccup_stats/api/v1/radio_versions/

Example HTTP response

Response 200

"object"

GET /hiccup_stats/api/v1/status/

Description

Get the number of devices, crashreports and heartbeats

Responses

HTTP Code	Description	Schema
200	OK	Status

Status

Name	Description	Schema
crashreports optional	Example : `0`	integer
devices optional	Example : `0`	integer
heartbeats optional	Example : `0`	integer

Security

Type	Name
oauth2	Google OAuth

Example HTTP request

Request path

/hiccup_stats/api/v1/status/

Example HTTP response

Response 200

"object"

GET /hiccup_stats/api/v1/version_daily/

Description

View for listing VersionDaily instances.

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth

Example HTTP request

Request path

/hiccup_stats/api/v1/version_daily/

Example HTTP response

Response 200

"object"

GET /hiccup_stats/api/v1/versions/

Description

View for listing versions.

Parameters

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

Responses

HTTP Code	Schema
200	Response 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

Security

Type	Name
oauth2	Google OAuth

Example HTTP request

Request path

/hiccup_stats/api/v1/versions/

Example HTTP response

Response 200

"object"

Definitions

CrashReport

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

CreateCrashreportResponseSchema

Name	Description	Schema
device_local_id optional	Example : `0`	integer

Device

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

DeviceCreate

Name	Description	Schema
board_date required	Example : `"string"`	string (date-time)
chipset required	Maximal length : `200` Example : `"string"`	string

DeviceRegisterResponseSchema

Name	Description	Schema
token optional	Maximal length : `200` Example : `"string"`	string
uuid optional read-only	Minimum length : `1` Example : `"string"`	string

HeartBeat

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

LogFile

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

RadioVersion

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

RadioVersionDaily

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

Version

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

VersionDaily

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

Security

Device token authentication

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

Google OAuth

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/

Hiccup API

Overview

Version information

URI scheme

Consumes

Produces

Paths

POST /hiccup/api/v1/crashreports/

Description

Body parameter

Responses

Tags

Security

Example HTTP request

Request path

Request body

Example HTTP response

Response 201

GET /hiccup/api/v1/crashreports/

Description

Parameters

Responses

Tags

Security

Example HTTP request

Request path

Example HTTP response

Response 200

GET /hiccup/api/v1/crashreports/{id}/

Description

Parameters

Responses

Tags

Security

Example HTTP request

Request path

Example HTTP response

Response 200

PUT /hiccup/api/v1/crashreports/{id}/

Description

Parameters

Body parameter

Responses

Tags

Security

Example HTTP request

Request path

Request body

Example HTTP response

Response 200

DELETE /hiccup/api/v1/crashreports/{id}/

Description

Parameters

Responses

Tags

Security

Example HTTP request

Request path

PATCH /hiccup/api/v1/crashreports/{id}/

Description

Parameters

Body parameter

Responses

Tags

Security

Example HTTP request

Request path

Request body

Example HTTP response

Response 200

POST /hiccup/api/v1/devices/

Description

Body parameter

Responses

Tags

Security

Example HTTP request

Request path

Request body

Example HTTP response