> For the complete documentation index, see [llms.txt](https://docs.auditbase.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.auditbase.com/api-access/v-1.1/objects-definitions.md).

# Objects Definitions

**ScanResultSuccess Object**

Stores the results a scan

| Field            | Type                   | Description |
| ---------------- | ---------------------- | ----------- |
| issues           | Array of Issue Objects |             |
| status           | String                 | "success"   |
| scan\_id         | String                 |             |
| num\_lines       | Integer                |             |
| severity\_counts | Severity Counts Object |             |
| score            | Integer                |             |
| timestamp        | Integer                |             |

**Issue Object**

| Field       | Type           |
| ----------- | -------------- |
| title       | String         |
| description | String         |
| severity    | Severity  Enum |
| snippet     | String         |

**ErrorResponse Object**

| Field          | Type   | Description    |
| -------------- | ------ | -------------- |
| status         | String | "failure"      |
| error\_message | String | failure reason |
| scan\_id       | String |                |

**ScanResultInProgress Object**

| Field    | Type   |                |
| -------- | ------ | -------------- |
| status   | String | "in\_progress" |
| scan\_id | String |                |

**Severity Counts Object**

| Field             | Type |
| ----------------- | ---- |
| high              | int  |
| medium            | int  |
| low               | int  |
| non\_critical     | int  |
| gas\_optimization | int  |

**Scan Placement Response Object**

| Field    | Type   | Description                                    |
| -------- | ------ | ---------------------------------------------- |
| status   | String | "success", "in\_progress", "failure"           |
| message  | String | If failed, give reason for failure             |
| scan\_id | String | Used to retreive scans results from get\_scans |

**Severity Enum**

An enum indicating the severity of the of the Issue

| Category          |                                                                                                                                                                                                                                                                           |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| high              | High flaws can result in the loss of assets or the alteration of data and are typically simple to exploit.  Some high flaws can be challenging to attack, but they can have a big impact on how smart contracts work, like giving the public access to essential features |
| medium            | Although medium-level vulnerabilities should be fixed, they cannot result in the loss of assets or the manipulation of data.                                                                                                                                              |
| low               | Low-level flaws are typically caused by bits of unneeded, old code that don't have a big influence on the execution.                                                                                                                                                      |
| non\_critical     | A non-critical issue refers to a bug or vulnerability that, while potentially inconvenient, does not pose an immediate or severe threat to the security, functionality, or performance of a smart contract.                                                               |
| gas\_optimization | The issue identifies unnecessary gas usage.                                                                                                                                                                                                                               |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.auditbase.com/api-access/v-1.1/objects-definitions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.