An interpretation is a bundled collection of filters, visualizations, and statistics based on a table in a collection. Use them to interpret and visualize results to gain a deeper understanding of the facts and insights hidden in the data. Your organization can have a maximum of 4,000 interpretations. Learn more about interpretations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/wegalvanize-interpretations-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: HighBond API Reference Interpretations API
version: 1.1.0
description: Welcome to the API documentation for HighBond.
x-logo:
url: ./assets/logo.png
altText: HighBond Logo
servers:
- url: '{protocol}://{server}/v1'
variables:
protocol:
default: https
server:
default: apis-us.highbond.com
enum:
- apis-us.highbond.com
- apis-ca.highbond.com
- apis-eu.highbond.com
- apis-ap.highbond.com
- apis-au.highbond.com
- apis-af.highbond.com
- apis-sa.highbond.com
- apis-jp.highbond.com
security:
- bearerToken: []
tags:
- name: Interpretations
description: 'An interpretation is a bundled collection of filters, visualizations, and statistics based on a table in a collection. Use them to interpret and visualize results to gain
a deeper understanding of the facts and insights hidden in the data.
Your organization can have a maximum of 4,000 interpretations.
Learn more about interpretations.'
paths:
/orgs/{org_id}/tables/{table_id}/interpretations:
get:
tags:
- Interpretations
operationId: getInterpretations
summary: List interpretations inside a table
description: Get a list of all interpretations inside a table.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/tableIdParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MultiInterpretationsResponse'
example:
data:
- id: '22'
type: interpretations
attributes:
title: interpretation 2
default: false
created_at: '2019-02-09T13:17:38Z'
updated_at: '2019-02-09T13:17:38Z'
relationships: {}
- id: '21'
type: interpretations
attributes:
title: interpretation 1
default: false
created_at: '2019-02-09T13:17:26Z'
updated_at: '2019-03-09T20:23:09Z'
relationships: {}
'400':
$ref: '#/components/responses/MissingTableId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
post:
tags:
- Interpretations
operationId: createInterpretation
summary: Create an interpretation
description: 'Create a new interpretation to provide a unique view of the data in the underlying source table.
Limitations:
* Your organization can have a maximum of 4,000 interpretations.'
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/tableIdParam'
requestBody:
description: The data required to create an interpretation.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CreateInterpretationPayload'
responses:
'201':
description: Created.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleInterpretationResponse'
'400':
$ref: '#/components/responses/ResourceTypeMismatch'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
'422':
description: 'Unprocessable entity.
'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 422
source:
pointer: /data/attributes/title
code: invalid_resource
detail: can't be blank
- status: 422
code: unprocessable_entity
detail: Maximum number of 4,000 Interpretations reached.
/orgs/{org_id}/interpretations/{id}:
get:
tags:
- Interpretations
operationId: getInterpretation
summary: Get an interpretation
description: Get information about an interpretation.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleInterpretationResponse'
'400':
$ref: '#/components/responses/MissingResourceId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
put:
tags:
- Interpretations
operationId: updateInterpretation
summary: Update an interpretation
description: Make changes to an interpretation, like renaming it. You do not need to update interpretations for them to reflect changes in data.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
requestBody:
description: The data required to update an interpretation.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateInterpretationPayload'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleInterpretationResponse'
'400':
$ref: '#/components/responses/ResourceIdConflict'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
'422':
description: 'Unprocessable entity.
'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 422
source:
pointer: /data/attributes/title
code: invalid_resource
detail: can't be blank.
delete:
tags:
- Interpretations
operationId: deleteInterpretation
summary: Delete an interpretation
description: 'If you no longer need an interpretation, you can permanently delete it.
> **Caution —**
Deleting an interpretation also deletes any visualizations created from that interpretation and removes those visualizations from storyboards. It does not delete the table where the interpretation exists.'
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
responses:
'204':
$ref: '#/components/responses/NoContent'
'400':
$ref: '#/components/responses/MissingOrgId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
components:
responses:
ResourceIdConflict:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: resource_id_conflict
title: Resource ID conflict
detail: 'The id specified in the request body, 1, conflicts with
the id specified in the path, 101.
'
MissingOrgId:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: parameter_missing
title: Parameter missing
detail: The required parameter, org_id, is missing.
BadCredentials:
description: Bad credentials.
Forbidden:
description: Forbidden.
NotFound:
description: Not found.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: '404'
title: Not Found
detail: The requested resource does not exist.
NotJsonapiMediaType:
description: Unsupported media type.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 415
code: unsupported_media_type
title: Unsupported media type
detail: 'The endpoint supports only the application/vnd.api+json Content-Type. This request specified application/json.
'
MissingResourceId:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: parameter_missing
title: Parameter missing
detail: The required parameter, id, is missing.
MissingTableId:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: parameter_missing
title: Parameter missing
detail: The required parameter, table_id, is missing.
NoContent:
description: No content.
ResourceTypeMismatch:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: resource_type_mismatch
title: Resource type mismatch
detail: 'The requested data type, a-bad-type, is incompatible with the endpoint.
'
parameters:
orgIdParam:
in: path
name: org_id
description: The ID of the HighBond instance.
required: true
schema:
type: string
example: 1
tableIdParam:
in: path
name: table_id
description: The ID of the table.
required: true
schema:
type: integer
example: 300
resourceIdParam:
in: path
name: id
description: The ID of the requested resource.
required: true
schema:
type: string
example: 9999
schemas:
CreateInterpretationPayload:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- type
- attributes
properties:
type:
type: string
description: The classification of the object (`"interpretations"`).
example: interpretations
attributes:
type: object
description: The attributes associated with the resource.
required:
- title
- raw
properties:
title:
type: string
description: The name of the interpretation.
maxLength: 255
example: My first Interpretation
raw:
type: string
description: A JSON string storing the configurations of an interpretation. See the response sample for details.
example: "{\n \"control_test_id\": 300,\n \"filterConfig\": {\n \"filtersOpen\": false,\n \"myRecords\": false,\n \"openStatuses\": true\n },\n \"formatVersion\": 1.16,\n \"tableConfig\": {\n \"columns\": [\n {\n \"fieldName\": \"account_number\",\n \"visible\": true\n },\n {\n \"fieldName\": \"balance\",\n \"visible\": true\n }\n ],\n \"formatting\": {}\n },\n \"visualizationConfig\": {\n \"colorMapping\": {}\n },\n \"visualizationInfo\": {\n \"currentTabIndex\": \"0,\",\n \"linkLatestTable\": \"false,\",\n \"selectedVizId\": \"e6c1,\",\n \"summary\": \"interpretation 101 summary,\",\n \"tableName\": \"table1,\",\n \"title\": \"interpretation 101\"\n },\n \"visualizations\": [\n {\n \"config\": {\n \"dataConfig\": {\n \"chartColumns\": [],\n \"chartRows\": [],\n \"chartValues\": []\n },\n \"displayConfig\": {}\n },\n \"id\": \"453d\",\n \"title\": \"interpretation visualization 1\",\n \"type\": \"SummaryTable\"\n }\n ]\n}\n"
default:
type: boolean
description: 'Specifies if the interpretation is the default interpretation for the table.
**Note:**
There is only one default interpretation allowed per table.
'
example: false
default: false
Error:
type: object
required:
- status
properties:
status:
type: string
description: The HTTP status code.
source:
type: object
description: Indicates which part of the request document caused the error.
required:
- pointer
properties:
pointer:
type: string
description: 'A JSON Pointer <a href="https://tools.ietf.org/html/rfc6901" target="_blank">(RFC6901)</a> to the associated entity
in the request document.
'
code:
type: string
description: Application-specific error code, expressed as a string value.
title:
type: string
description: A short, human-readable summary of the problem.
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem.
SingleInterpretationResponse:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
- relationships
properties:
id:
type: string
description: The ID of the interpretation.
example: '4001'
type:
type: string
description: The classification of the object (`"interpretations"`).
example: interpretations
attributes:
type: object
description: The attributes associated with the resource.
properties:
title:
type: string
description: The name of the interpretation.
maxLength: 255
example: My first Interpretation
raw:
type: string
description: A JSON string storing the configurations of an interpretation. See the response sample for details.
example: "{\n \"control_test_id\": 300,\n \"filterConfig\": {\n \"filtersOpen\": false,\n \"myRecords\": false,\n \"openStatuses\": true\n },\n \"formatVersion\": 1.16,\n \"tableConfig\": {\n \"columns\": [\n {\n \"fieldName\": \"account_number\",\n \"visible\": true\n },\n {\n \"fieldName\": \"balance\",\n \"visible\": true\n }\n ],\n \"formatting\": {}\n },\n \"visualizationConfig\": {\n \"colorMapping\": {}\n },\n \"visualizationInfo\": {\n \"currentTabIndex\": \"0,\",\n \"linkLatestTable\": \"false,\",\n \"selectedVizId\": \"e6c1,\",\n \"summary\": \"interpretation 101 summary,\",\n \"tableName\": \"table1,\",\n \"title\": \"interpretation 101\"\n },\n \"visualizations\": [\n {\n \"config\": {\n \"dataConfig\": {\n \"chartColumns\": [],\n \"chartRows\": [],\n \"chartValues\": []\n },\n \"displayConfig\": {}\n },\n \"id\": \"453d\",\n \"title\": \"interpretation visualization 1\",\n \"type\": \"SummaryTable\"\n }\n ]\n}\n"
default:
type: boolean
description: 'Specifies if the interpretation is the default interpretation for the table.
**Note:**
There is only one default interpretation allowed per table.
'
example: false
default: false
created_at:
type: string
description: The date the interpretation was created.
example: '2019-02-09T13:17:26Z'
format: date-time
updated_at:
type: string
description: The date the interpretation was updated.
example: '2019-03-18T22:02:05Z'
format: date-time
relationships:
type: object
description: The relationships associated with the resource.
properties:
table:
$ref: '#/components/schemas/RelationshipObject'
example:
table:
data:
id: '300'
type: tables
MultiInterpretationsResponse:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: array
description: The data associated with the resource.
items:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
properties:
id:
type: string
description: The ID of the interpretation.
example: '4001'
type:
type: string
description: The classification of the object (`"interpretations"`).
example: interpretations
attributes:
type: object
description: The attributes associated with the resource.
properties:
title:
type: string
description: The name of the interpretation.
maxLength: 255
example: My first Interpretation
default:
type: boolean
description: 'Specifies if the interpretation is the default interpretation for the table.
**Note:**
There is only one default interpretation allowed per table.
'
example: false
default: false
created_at:
type: string
description: The date the interpretation was created.
example: '2019-02-09T13:17:26Z'
format: date-time
updated_at:
type: string
description: The date the interpretation was updated.
example: '2019-03-18T22:02:05Z'
format: date-time
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
UpdateInterpretationPayload:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
properties:
id:
type: string
description: The ID of the interpretation.
example: '4001'
type:
type: string
description: The classification of the object (`"interpretations"`).
example: interpretations
attributes:
type: object
description: The attributes associated with the resource.
properties:
title:
type: string
description: The name of the interpretation.
maxLength: 255
example: My first Interpretation
raw:
type: string
description: A JSON string storing the configurations of an interpretation. See the response sample for details.
example: "{\n \"control_test_id\": 300,\n \"filterConfig\": {\n \"filtersOpen\": false,\n \"myRecords\": false,\n \"openStatuses\": true\n },\n \"formatVersion\": 1.16,\n \"tableConfig\": {\n \"columns\": [\n {\n \"fieldName\": \"account_number\",\n \"visible\": true\n },\n {\n \"fieldName\": \"balance\",\n \"visible\": true\n }\n ],\n \"formatting\": {}\n },\n \"visualizationConfig\": {\n \"colorMapping\": {}\n },\n \"visualizationInfo\": {\n \"currentTabIndex\": \"0,\",\n \"linkLatestTable\": \"false,\",\n \"selectedVizId\": \"e6c1,\",\n \"summary\": \"interpretation 101 summary,\",\n \"tableName\": \"table1,\",\n \"title\": \"interpretation 101\"\n },\n \"visualizations\": [\n {\n \"config\": {\n \"dataConfig\": {\n \"chartColumns\": [],\n \"chartRows\": [],\n \"chartValues\": []\n },\n \"displayConfig\": {}\n },\n \"id\": \"453d\",\n \"title\": \"interpretation visualization 1\",\n \"type\": \"SummaryTable\"\n }\n ]\n}\n"
RelationshipObject:
type: object
description: The object related to the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the related object.
required:
- id
- type
properties:
id:
type: string
description: The ID of the related object.
example: 1
type:
type: string
description: The classification of the related object.
example: collection
securitySchemes:
bearerToken:
description: 'HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a
safe and secure way to access data, while protecting your account credentials.
'
type: http
scheme: bearer
bearerFormat: oauth2
x-tagGroups:
- name: Core resources
tags:
- Robots Agents
- Robots
- Robot Tasks
- Robot Jobs
- Robot Apps
- Robot Script Versions
- Robot Activations
- Robot Files
- Robot Working Files
- Robot Collaborators
- Robots Folders Collaborators
- Robot Users
- Robots Folders
- Storyboards
- Collections
- Questionnaires
- Analyses
- Surveys
- Event Reports
- Tables
- Table columns
- Records
- Record columns
- Record statuses
- Interpretations
- Metrics
- Workflow Groups
- Results Users
- Results Triggers
- Project types
- Custom attributes
- Request item statuses
- Projects
- Projects Admin
- Planning files
- Results files
- Objectives
- Narratives
- Risks
- Controls
- Control performance schedules
- Mitigations
- Control test plans
- Control tests
- Attachments
- Walkthroughs
- Issues
- Actions
- Collaborators
- Request Items
- To-dos
- Sign-offs
- Entities
- Scheduler Filters
- Frameworks
- Handlers
- Workflows in Asset Inventory/Asset Manager
- Asset types
- Asset record types
- Attribute types
- Assets
- Asset Relationships
- Asset records
- Asset Record Relationships
- Events
- Template Toolkits
- Toolkits
- Roles
- Role Deletion
- Compliance Maps
- Time entries
- Non-project time categories
- Timesheets
- Importer
- System Users
- Organizations
- Impact Reports
- Activities
- Users
- Groups
- Scheduled Users
- Scheduled Projects
- Scheduled Hours
- Extract
- Strategy