Hiccup API

Overview

Paths

POST /hiccup/api/v1/devices/

Body parameter

Name : data
Flags : optional

Name	Description	Schema
board_date optional	Example : "string"	string
chipset optional	Example : "string"	string
imei optional	Example : "string"	string
last_heartbeat optional	Example : "string"	string
next_per_crashreport_key optional	Example : "string"	string
next_per_heartbeat_key optional	Example : "string"	string
token optional	Example : "string"	string
user required	Example : "string"	string

Responses

HTTP Code	Schema
201	No Content

Consumes

• application/json

Tags

• devices

Example HTTP request

Request path

/hiccup/api/v1/devices/

Request body

json :
{
  "board_date" : "string",
  "next_per_heartbeat_key" : "string",
  "next_per_crashreport_key" : "string",
  "token" : "string",
  "user" : "string",
  "imei" : "string",
  "chipset" : "string",
  "last_heartbeat" : "string"
}

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

Responses

HTTP Code	Schema
201	No Content

Tags

• register

Example HTTP request

Request path

/hiccup/api/v1/devices/register/

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

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	string
Query	limit optional	string
Query	offset optional	string

Responses

HTTP Code	Schema
200	No Content

Tags

• crashreports

Example HTTP request

Request path

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

Request query

json :
{
  "limit" : "string",
  "offset" : "string"
}

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

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
app_version required	Example : "string"	string
boot_reason required	Example : "string"	string
build_fingerprint required	Example : "string"	string
date required	Example : "string"	string
device_local_id optional	Example : "string"	string
is_fake_report optional	Example : "string"	string
next_logfile_key optional	Example : "string"	string
power_off_reason required	Example : "string"	string
power_on_reason required	Example : "string"	string
radio_version optional	Example : "string"	string
uptime required	Example : "string"	string
uuid required	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• crashreports

Example HTTP request

Request path

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

Request body

json :
{
  "uptime" : "string",
  "is_fake_report" : "string",
  "uuid" : "string",
  "boot_reason" : "string",
  "power_on_reason" : "string",
  "build_fingerprint" : "string",
  "power_off_reason" : "string",
  "radio_version" : "string",
  "next_logfile_key" : "string",
  "date" : "string",
  "app_version" : "string",
  "device_local_id" : "string"
}

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

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	string

Responses

HTTP Code	Schema
204	No Content

Tags

• crashreports

Example HTTP request

Request path

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

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

Parameters

Type	Name	Schema
Path	device__uuid required	string
Path	device_local_id required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
app_version optional	Example : "string"	string
boot_reason optional	Example : "string"	string
build_fingerprint optional	Example : "string"	string
date optional	Example : "string"	string
device_local_id optional	Example : "string"	string
is_fake_report optional	Example : "string"	string
next_logfile_key optional	Example : "string"	string
power_off_reason optional	Example : "string"	string
power_on_reason optional	Example : "string"	string
radio_version optional	Example : "string"	string
uptime optional	Example : "string"	string
uuid optional	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• crashreports

Example HTTP request

Request path

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

Request body

json :
{
  "uptime" : "string",
  "is_fake_report" : "string",
  "uuid" : "string",
  "boot_reason" : "string",
  "power_on_reason" : "string",
  "build_fingerprint" : "string",
  "power_off_reason" : "string",
  "radio_version" : "string",
  "next_logfile_key" : "string",
  "date" : "string",
  "app_version" : "string",
  "device_local_id" : "string"
}

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

Parameters

Type	Name	Schema
Path	uuid required	string
Query	limit optional	string
Query	offset optional	string

Responses

HTTP Code	Schema
200	No Content

Tags

• devices

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

Request query

json :
{
  "limit" : "string",
  "offset" : "string"
}

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

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
board_date optional	Example : "string"	string
chipset optional	Example : "string"	string
imei optional	Example : "string"	string
last_heartbeat optional	Example : "string"	string
next_per_crashreport_key optional	Example : "string"	string
next_per_heartbeat_key optional	Example : "string"	string
token optional	Example : "string"	string
user required	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• devices

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

Request body

json :
{
  "board_date" : "string",
  "next_per_heartbeat_key" : "string",
  "next_per_crashreport_key" : "string",
  "token" : "string",
  "user" : "string",
  "imei" : "string",
  "chipset" : "string",
  "last_heartbeat" : "string"
}

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

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Schema
204	No Content

Tags

• devices

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

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

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
board_date optional	Example : "string"	string
chipset optional	Example : "string"	string
imei optional	Example : "string"	string
last_heartbeat optional	Example : "string"	string
next_per_crashreport_key optional	Example : "string"	string
next_per_heartbeat_key optional	Example : "string"	string
token optional	Example : "string"	string
user optional	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• devices

Example HTTP request

Request path

/hiccup/api/v1/devices/string/

Request body

json :
{
  "board_date" : "string",
  "next_per_heartbeat_key" : "string",
  "next_per_crashreport_key" : "string",
  "token" : "string",
  "user" : "string",
  "imei" : "string",
  "chipset" : "string",
  "last_heartbeat" : "string"
}

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

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
app_version required	Example : "string"	string
boot_reason required	Example : "string"	string
build_fingerprint required	Example : "string"	string
date required	Example : "string"	string
device_local_id optional	Example : "string"	string
is_fake_report optional	Example : "string"	string
next_logfile_key optional	Example : "string"	string
power_off_reason required	Example : "string"	string
power_on_reason required	Example : "string"	string
radio_version optional	Example : "string"	string
uptime required	Example : "string"	string
uuid required	Example : "string"	string

Responses

HTTP Code	Schema
201	No Content

Consumes

• application/json

Tags

• crashreports

Example HTTP request

Request path

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

Request body

json :
{
  "uptime" : "string",
  "is_fake_report" : "string",
  "uuid" : "string",
  "boot_reason" : "string",
  "power_on_reason" : "string",
  "build_fingerprint" : "string",
  "power_off_reason" : "string",
  "radio_version" : "string",
  "next_logfile_key" : "string",
  "date" : "string",
  "app_version" : "string",
  "device_local_id" : "string"
}

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

Parameters

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

Responses

HTTP Code	Schema
201	No Content

Tags

• logfile_put

Example HTTP request

Request path

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

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

Parameters

Type	Name	Schema
Path	uuid required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
app_version required	Example : "string"	string
build_fingerprint required	Example : "string"	string
date required	Example : "string"	string
device_local_id optional	Example : "string"	string
radio_version optional	Example : "string"	string
uptime required	Example : "string"	string
uuid required	Example : "string"	string

Responses

HTTP Code	Schema
201	No Content

Consumes

• application/json

Tags

• heartbeats

Example HTTP request

Request path

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

Request body

json :
{
  "uptime" : "string",
  "uuid" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "date" : "string",
  "app_version" : "string",
  "device_local_id" : "string"
}

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

Parameters

Type	Name	Schema
Path	device_local_id required	string
Path	uuid required	string
Query	limit optional	string
Query	offset optional	string

Responses

HTTP Code	Schema
200	No Content

Tags

• heartbeats

Example HTTP request

Request path

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

Request query

json :
{
  "limit" : "string",
  "offset" : "string"
}

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

Parameters

Type	Name	Schema
Path	device_local_id required	string
Path	uuid required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
app_version required	Example : "string"	string
build_fingerprint required	Example : "string"	string
date required	Example : "string"	string
device_local_id optional	Example : "string"	string
radio_version optional	Example : "string"	string
uptime required	Example : "string"	string
uuid required	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• heartbeats

Example HTTP request

Request path

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

Request body

json :
{
  "uptime" : "string",
  "uuid" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "date" : "string",
  "app_version" : "string",
  "device_local_id" : "string"
}

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

Parameters

Type	Name	Schema
Path	device_local_id required	string
Path	uuid required	string

Responses

HTTP Code	Schema
204	No Content

Tags

• heartbeats

Example HTTP request

Request path

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

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

Parameters

Type	Name	Schema
Path	device_local_id required	string
Path	uuid required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
app_version optional	Example : "string"	string
build_fingerprint optional	Example : "string"	string
date optional	Example : "string"	string
device_local_id optional	Example : "string"	string
radio_version optional	Example : "string"	string
uptime optional	Example : "string"	string
uuid optional	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• heartbeats

Example HTTP request

Request path

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

Request body

json :
{
  "uptime" : "string",
  "uuid" : "string",
  "build_fingerprint" : "string",
  "radio_version" : "string",
  "date" : "string",
  "app_version" : "string",
  "device_local_id" : "string"
}

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

Parameters

Type	Name	Schema
Path	pk required	string
Query	limit optional	string
Query	offset optional	string

Responses

HTTP Code	Schema
200	No Content

Tags

• logfiles

Example HTTP request

Request path

/hiccup/api/v1/logfiles/string/

Request query

json :
{
  "limit" : "string",
  "offset" : "string"
}

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

Parameters

Type	Name	Schema
Path	pk required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
crashreport required	Example : "string"	string
crashreport_local_id optional	Example : "string"	string
logfile required	Example : "string"	string
logfile_type optional	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• logfiles

Example HTTP request

Request path

/hiccup/api/v1/logfiles/string/

Request body

json :
{
  "logfile" : "string",
  "crashreport" : "string",
  "crashreport_local_id" : "string",
  "logfile_type" : "string"
}

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

Parameters

Type	Name	Schema
Path	pk required	string

Responses

HTTP Code	Schema
204	No Content

Tags

• logfiles

Example HTTP request

Request path

/hiccup/api/v1/logfiles/string/

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

Parameters

Type	Name	Schema
Path	pk required	string

Body parameter

Name : data
Flags : optional

Name	Description	Schema
crashreport optional	Example : "string"	string
crashreport_local_id optional	Example : "string"	string
logfile optional	Example : "string"	string
logfile_type optional	Example : "string"	string

Responses

HTTP Code	Schema
200	No Content

Consumes

• application/json

Tags

• logfiles

Example HTTP request

Request path

/hiccup/api/v1/logfiles/string/

Request body

json :
{
  "logfile" : "string",
  "crashreport" : "string",
  "crashreport_local_id" : "string",
  "logfile_type" : "string"
}

GET /hiccup/docs/

Responses

HTTP Code	Schema
200	No Content

Tags

• docs

Example HTTP request

Request path

/hiccup/docs/

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

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Schema
200	No Content

Tags

• device_overview

Example HTTP request

Request path

/hiccup_stats/api/v1/device_overview/string/

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

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Schema
200	No Content

Tags

• device_report_history

Example HTTP request

Request path

/hiccup_stats/api/v1/device_report_history/string/

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

Parameters

Type	Name	Schema
Path	uuid required	string

Responses

HTTP Code	Schema
200	No Content

Tags

• device_update_history

Example HTTP request

Request path

/hiccup_stats/api/v1/device_update_history/string/

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

Parameters

Type	Name	Schema
Path	id required	string

Responses

HTTP Code	Schema
200	No Content

Tags

• logfile_download

Example HTTP request

Request path

/hiccup_stats/api/v1/logfile_download/string/

GET /hiccup_stats/api/v1/status/

Responses

HTTP Code	Schema
200	No Content

Tags

• status

Example HTTP request

Request path

/hiccup_stats/api/v1/status/

GET /hiccup_stats/api/v1/version_daily/

Parameters

Type	Name	Schema
Query	date optional	string
Query	date_end optional	string
Query	date_start optional	string
Query	heartbeats optional	string
Query	limit optional	string
Query	offset optional	string
Query	other optional	string
Query	prob_crashes optional	string
Query	smpl optional	string
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	No Content

Tags

• version_daily

Example HTTP request

Request path

/hiccup_stats/api/v1/version_daily/

Request query

json :
{
  "date" : "string",
  "date_end" : "string",
  "date_start" : "string",
  "heartbeats" : "string",
  "limit" : "string",
  "offset" : "string",
  "other" : "string",
  "prob_crashes" : "string",
  "smpl" : "string",
  "version" : "string",
  "version__build_fingerprint" : "string",
  "version__is_beta_release" : "string",
  "version__is_official_release" : "string"
}

GET /hiccup_stats/api/v1/versions/

Parameters

Type	Name	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	string
Query	is_beta_release optional	string
Query	is_official_release optional	string
Query	limit optional	string
Query	offset optional	string
Query	other optional	string
Query	prob_crashes optional	string
Query	released_after optional	string
Query	released_before optional	string
Query	released_on optional	string
Query	smpl optional	string

Responses

HTTP Code	Schema
200	No Content

Tags

• versions

Example HTTP request

Request path

/hiccup_stats/api/v1/versions/

Request query

json :
{
  "build_fingerprint" : "string",
  "first_seen_after" : "string",
  "first_seen_before" : "string",
  "first_seen_on" : "string",
  "heartbeats" : "string",
  "is_beta_release" : "string",
  "is_official_release" : "string",
  "limit" : "string",
  "offset" : "string",
  "other" : "string",
  "prob_crashes" : "string",
  "released_after" : "string",
  "released_before" : "string",
  "released_on" : "string",
  "smpl" : "string"
}

Security

basic

Type : basic