Skip to content
forgit api docs

Get a report

GET
/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}

Returns a single Report matching the provided ID.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug
required
string

The repository.

commit
required
string

The commit the report belongs to.

reportId
required
string

Either the uuid or external-id of the report.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
type
required
string
uuid

The UUID that can be used to identify the report.

string
title

The title of the report.

string
details

A string to describe the purpose of the report.

string
external_id

ID of the report provided by the report creator. It can be used to identify the report as an alternative to it’s generated uuid. It is not used by Bitbucket, but only by the report creator for updating or deleting this specific report. Needs to be unique.

string
reporter

A string to describe the tool or company who created the report.

string
link

A URL linking to the results of the report in an external tool.

string format: uri
remote_link_enabled

If enabled, a remote link is created in Jira for the work item associated with the commit the report belongs to.

boolean
logo_url

A URL to the report logo. If none is provided, the default insights logo will be used.

string format: uri
report_type

The type of the report.

string
Allowed values: SECURITY COVERAGE TEST BUG
result

The state of the report. May be set to PENDING and later updated.

string
Allowed values: PASSED FAILED PENDING
data

An array of data fields to display information on the report. Maximum 10.

Array<object>
Report Data

A key-value element that will be displayed along with the report.

object
type

The type of data contained in the value field. If not provided, then the value will be detected as a boolean, number or string.

string
Allowed values: BOOLEAN DATE DURATION LINK NUMBER PERCENTAGE TEXT
title

A string describing what this data field represents.

string
value

The value of the data element.

object
created_on

The timestamp when the report was created.

string format: date-time
updated_on

The timestamp when the report was updated.

string format: date-time
Example 
{
  "report_type": "SECURITY",
  "result": "PASSED",
  "data": [
    {
      "type": "BOOLEAN"
    }
  ]
}

404

Section titled “ 404 ”

The report with the given ID was not found.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}