An analysis is a second-level container. Analyses live in collections, and they are used to organize tables. Once you have created a collection, you can add one or more analyses to that collection. Your organization can have a maximum of 2,000 analyses. Learn more about analyses.
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-analyses-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 Analyses 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: Analyses
description: 'An analysis is a second-level container. Analyses live in collections, and they are used to organize tables. Once you have created a collection, you can add one or
more analyses to that collection.
Your organization can have a maximum of 2,000 analyses.
Learn more about analyses.'
paths:
/orgs/{org_id}/collections/{collection_id}/analyses:
get:
tags:
- Analyses
operationId: getAnalyses
summary: List analyses inside a collection
description: Get a list of all analyses inside a collection.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/collectionIdParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MultiAnalysesResponse'
example:
data:
- id: '22'
type: analyses
attributes:
name: analysis 2
description: analysis 2 description
created_at: '2019-02-09T13:17:38Z'
updated_at: '2019-02-09T13:17:38Z'
relationships:
collection:
data:
id: '2'
type: collections
- id: '21'
type: analyses
attributes:
name: analysis 1
description: analysis 1 description
created_at: '2019-02-09T13:17:26Z'
updated_at: '2019-03-09T20:23:09Z'
relationships:
collection:
data:
id: '2'
type: collections
'400':
$ref: '#/components/responses/MissingCollectionId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
post:
tags:
- Analyses
operationId: createAnalysis
summary: Create an analysis
description: 'Create a new analysis in an existing collection.
Limitations:
* Your organization can have a maximum of 2,000 analyses.'
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/collectionIdParam'
requestBody:
description: The data required to create an analysis.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CreateAnalysisPayload'
responses:
'201':
description: Created.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleAnalysisResponse'
'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/name
code: invalid_resource
detail: can't be blank
- status: 422
code: unprocessable_entity
detail: Maximum number of 2,000 Analyses reached.
/orgs/{org_id}/analyses/{id}:
get:
tags:
- Analyses
operationId: getAnalysis
summary: Get an analysis
description: Get information about an analysis.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleAnalysisResponse'
'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:
- Analyses
operationId: updateAnalysis
summary: Update an analysis
description: Make changes to an analysis, like renaming it. You do not need to update analyses for them to reflect changes in data.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
requestBody:
description: The data required to update an analysis.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateAnalysisPayload'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleAnalysisResponse'
'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/name
code: invalid_resource
detail: is too long (maximum is 255 characters)
delete:
tags:
- Analyses
operationId: deleteAnalysis
summary: Delete an analysis
description: 'Permanently delete an analysis.
> **Caution —**
Deleting an analysis also permanently removes tables associated with the analysis.'
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
responses:
'202':
$ref: '#/components/responses/Accepted'
'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:
schemas:
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
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
MultiAnalysesResponse:
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
- relationships
properties:
id:
type: string
description: The ID of the requested resource.
example: '20'
type:
type: string
description: The classification of the object (`"analyses"`).
example: analyses
attributes:
type: object
description: The attributes associated with the resource.
properties:
name:
type: string
description: The name of the analysis.
maxLength: 255
example: My first Analysis
description:
type: string
description: The description of the analysis.
example: Description of My first Analysis
created_at:
type: string
description: The date the analysis was created.
example: '2019-02-09T13:17:26Z'
format: date-time
updated_at:
type: string
description: The date the analysis was updated.
example: '2019-03-18T22:02:05Z'
format: date-time
relationships:
type: object
description: The relationships associated with the resource.
properties:
collection:
$ref: '#/components/schemas/RelationshipObject'
example:
collection:
data:
id: '1'
type: collections
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.
UpdateAnalysisPayload:
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 requested resource.
example: '20'
type:
type: string
description: The classification of the object (`"analyses"`).
example: analyses
attributes:
type: object
description: The attributes associated with the resource.
required:
- name
properties:
name:
type: string
description: The name of the analysis.
maxLength: 255
example: My first Analysis
description:
type: string
description: The description of the analysis.
example: Description of My first Analysis
SingleAnalysisResponse:
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 requested resource.
example: '20'
type:
type: string
description: The classification of the object (`"analyses"`).
example: analyses
attributes:
type: object
description: The attributes associated with the resource.
properties:
name:
type: string
description: The name of the analysis.
maxLength: 255
example: My first Analysis
description:
type: string
description: The description of the analysis.
example: Description of My first Analysis
created_at:
type: string
description: The date the analysis was created.
example: '2019-02-09T13:17:26Z'
format: date-time
updated_at:
type: string
description: The date the analysis was updated.
example: '2019-03-18T22:02:05Z'
format: date-time
relationships:
type: object
description: The relationships associated with the resource.
properties:
collection:
$ref: '#/components/schemas/RelationshipObject'
example:
collection:
data:
id: '1'
type: collections
CreateAnalysisPayload:
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 (`"analyses"`).
example: analyses
attributes:
type: object
description: The attributes associated with the resource.
required:
- name
properties:
name:
type: string
description: The name of the analysis.
maxLength: 255
example: My first Analysis
description:
type: string
description: The description of the analysis.
example: Description of My first Analysis
responses:
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.
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.
'
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.
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.
'
Accepted:
description: Accepted.
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.
'
Forbidden:
description: Forbidden.
MissingCollectionId:
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, collection_id, is missing.
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.
parameters:
collectionIdParam:
in: path
name: collection_id
description: The ID of the collection.
required: true
schema:
type: integer
example: 1
resourceIdParam:
in: path
name: id
description: The ID of the requested resource.
required: true
schema:
type: string
example: 9999
orgIdParam:
in: path
name: org_id
description: The ID of the HighBond instance.
required: true
schema:
type: string
example: 1
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