Bugfender API (1.0.0-BETA)

Download OpenAPI specification:Download

Describes how to access Bugfender services programmatically.

NOTE: The public API is currently in beta stage and subject to change. Please consider contacting support to provide any feedback.

Authentication

OAuthAccessCode

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: /auth/authorize
Token URL: /auth/token
Scopes:
  • all -

    Main scope for authorized requests.

OAuthPassword

Security Scheme Type OAuth2
password OAuth Flow
Token URL: /auth/token
Scopes:
  • all -

    Main scope for authorized requests.

App

Get Apps List

Retrieves the list of all Apps that current user has access to.

Note that display_options and s3 entries are not returned for this endpoint.

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get App Devices

Retrieves Devices associated with given App.

In format: json, supports pagination through a Pager object returned along with the data.

Note that error responses are always returned as application/json.

Authorizations:
path Parameters
id
required
integer

App ID

query Parameters
data_range_end
string

If provided, retrieves only only Devices registered before or at the given Date. Must be formatted as RFC3339 compliant string.

data_range_start
string

If provided, retrieves only only Devices registered at or after the given Date. Must be formatted as RFC3339 compliant string.

device_id
string

If provided, retrieves only Devices matching the ID. A * can be used to perform a prefix match.

Note that this is the UUID assigned to Device, not the numeric ID used to identify Device in other API queries.

device_key_values
string

If provided, retrieves only Devices matching filter based on custom Device Data.

Format is a space separated list of filters in form of either key=value or value. The later will match value against all existing keys. Quotes can be used to specify values with spaces. Quotes and backslashes can be escaped with backslash (e.g. \", \\).

device_model
string

If provided, retrieves only Devices matching the Model.

device_name
string

If provided, retrieves only Devices matching the Name. A * can be used to perform a prefix match.

device_status
integer

If provided, retrieves only Devices that are Enabled(1) or Disabled(0).

format
string
Enum: "csv" "json" "ndjson"

Format in which to return data. If not specified, downloads Devices as csv file.

language
string

If provided, retrieves only Devices matching the Language.

order
string
Enum: "seen" "new" "old" "nameaz" "nameza"
os_version
string

If provided, retrieves only Devices matching the OS Version.

page
integer

Page number to retrieve when using paginated results.

page_size
integer

Size (i.e. number of items) of the page for paginated results.

version
integer

If provided, retrieves only Devices matching the App Version.

Responses

Response samples

Content type
{
  • "devices": [
    ],
  • "item_count": 0,
  • "out_of_retention_period": true,
  • "page_index": 0,
  • "page_size": 0,
  • "total_pages": 0
}

Get App Logs

Retrieves logs for a given App ID.

Note that application/json formatting is only really used for reporting errors. Successfull responses should expect the format to be as specificed in the format parameter.

Authorizations:
path Parameters
id
required
integer

App ID

query Parameters
date_range_end
string

If provided, retrieves only Logs before or at the given Date. Must be formatted as RFC3339 compliant string.

date_range_start
string

If provided, retrieves only Logs at or after the given Date. Must be formatted as RFC3339 compliant string.

device_id
integer

If provided, retrieves only Logs related to this Device. Note that this is not Device ID reported by the SDK, it has to be obtained by the /api/app/{id}/devices call.

format
string
Enum: "ndjson" "csv" "event-stream"

Format in which to return data. If not specified, downloads currently available Logs as text file.

level
integer

If provided, retrieves only Logs at or above the given Level. Log levels are ordered in this following way: Fatal, Error, Warning, Info, Debug, Trace (from more to less critical). Permitted levels are: Debug = 0, Warning = 1, Error = 2, Trace = 3, Info = 4, Fatal = 5 (note enum numbers are not sorted, this is for backwards compatibility with previous clients)

session
string

If provided, retrieves only Logs matching the Session ID.

tags
string

If provided, retrieves only Logs with given Tag(s). Multiple Tags can be specified by a comma separated string.

tail
string

If set to true and format: event-stream, keep the connection open and keep sending in new Logs.

text
string

Unused.

tz
string

Only for text file download. Converts Log timestamps to be in the given timezone.

Responses

Response samples

Content type