Roark Issue API
The Issue API from Roark — 2 operation(s) for issue.
The Issue API from Roark — 2 operation(s) for issue.
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/roark:roark-issue-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: Roark Analytics Issue API
description: The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform.
version: 1.0.0
servers:
- description: Production
url: https://api.roark.ai
security:
- Bearer: []
tags:
- name: Issue
paths:
/v1/issue:
get:
responses:
'200':
description: List of issues
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Issue'
pagination:
type: object
properties:
limit:
type: integer
offset:
type: integer
hasMore:
type: boolean
required:
- limit
- offset
- hasMore
required:
- data
- pagination
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Validation error
example:
type: validation
code: invalid_parameter
message: The request was invalid
param: email
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Authentication error
example:
type: authentication
code: unauthorized
message: Authentication required
description: Unauthorized
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server error
example:
type: internal
code: internal_error
message: Internal server error
description: Internal Server Error
operationId: getV1Issue
tags:
- Issue
summary: List issues
description: Returns the project’s issues, ordered newest-first. Supports filtering by status, source, and severity, with offset pagination.
parameters:
- in: query
name: status
schema:
type: string
enum:
- OPEN
- ACKED
- RESOLVED
description: Lifecycle state
- in: query
name: source
schema:
type: string
enum:
- TREND_ALERT
- SINGLE_CALL_ALERT
- TRACE_FAILURE
- MANUAL
- API
- AGENT
description: Who opened the issue
- in: query
name: severity
schema:
type: string
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: Coarse priority — LOW / MEDIUM / HIGH / CRITICAL
- in: query
name: limit
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: 'Maximum number of issues to return (default: 20, max: 100)'
- in: query
name: offset
schema:
type: integer
minimum: 0
default: 0
description: Pagination offset
post:
responses:
'201':
description: The created issue
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Issue'
required:
- data
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Validation error
example:
type: validation
code: invalid_parameter
message: The request was invalid
param: email
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Authentication error
example:
type: authentication
code: unauthorized
message: Authentication required
description: Unauthorized
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server error
example:
type: internal
code: internal_error
message: Internal server error
description: Internal Server Error
operationId: postV1Issue
tags:
- Issue
summary: Create issue
description: 'Opens a new issue with `source: API`. The supplied evidence (calls / chats) is attached in the same transaction; an invalid reference fails the whole request rather than leaving a half-created issue.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIssueInput'
/v1/issue/{issueId}:
get:
responses:
'200':
description: The requested issue
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Issue'
required:
- data
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Authentication error
example:
type: authentication
code: unauthorized
message: Authentication required
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not found error
example:
type: not_found
code: resource_not_found
message: The requested resource could not be found
description: Not Found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server error
example:
type: internal
code: internal_error
message: Internal server error
description: Internal Server Error
operationId: getV1IssueByIssueId
tags:
- Issue
summary: Get issue by ID
description: Returns a single issue with its evidence rows.
parameters:
- name: issueId
in: path
required: true
schema:
type: string
components:
schemas:
ErrorResponse:
type: object
properties:
type:
type: string
enum:
- validation
- authentication
- forbidden
- not_found
- conflict
- payment_required
- rate_limit
- internal
description: The error type category
examples:
- validation
- authentication
code:
type: string
description: Machine-readable error code identifier
examples:
- invalid_parameter
- missing_required_field
- unauthorized
message:
type: string
description: Human-readable error message
examples:
- The request was invalid
- Authentication required
param:
type: string
description: The parameter that caused the error (if applicable)
examples:
- email
- user_id
details:
description: Additional error context information
required:
- type
- code
- message
CreateIssueEvidence:
type: object
properties:
callId:
type: string
format: uuid
chatId:
type: string
format: uuid
description: A call or chat to attach as evidence (exactly one of `callId` / `chatId`)
IssueEvidence:
type: object
properties:
id:
type: string
format: uuid
callId:
type:
- string
- 'null'
format: uuid
description: Call attached as evidence, or null
chatId:
type:
- string
- 'null'
format: uuid
description: Chat attached as evidence, or null
observedAt:
type: string
description: When the evidence was observed (ISO-8601)
required:
- id
- callId
- chatId
- observedAt
CreateIssueInput:
type: object
properties:
title:
type: string
minLength: 1
maxLength: 280
description: Short headline — required, max 280 characters
summary:
type:
- string
- 'null'
minLength: 1
maxLength: 2000
description: Longer-form context — optional, max 2000 characters
severity:
type:
- string
- 'null'
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: Coarse priority. Null when unset.
evidence:
type: array
items:
$ref: '#/components/schemas/CreateIssueEvidence'
maxItems: 50
default: []
description: Calls / chats to attach as evidence. Optional; max 50 entries per issue.
required:
- title
Issue:
type: object
properties:
id:
type: string
format: uuid
organizationId:
type: string
format: uuid
projectId:
type: string
format: uuid
alertId:
type:
- string
- 'null'
format: uuid
description: Only set when source is an alert
source:
type: string
enum:
- TREND_ALERT
- SINGLE_CALL_ALERT
- TRACE_FAILURE
- MANUAL
- API
- AGENT
description: Who opened the issue
title:
type: string
summary:
type:
- string
- 'null'
severity:
type:
- string
- 'null'
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: Coarse priority — LOW / MEDIUM / HIGH / CRITICAL
status:
type: string
enum:
- OPEN
- ACKED
- RESOLVED
description: Lifecycle state
fingerprint:
type: string
description: Producer-supplied dedup key. Same fingerprint coalesces into the same issue.
eventCount:
type: integer
description: How many times this issue has been observed.
lastEventAt:
type:
- string
- 'null'
description: Timestamp of the most recent occurrence, or null if no events yet.
openedAt:
type: string
resolvedAt:
type:
- string
- 'null'
assigneeUserId:
type:
- string
- 'null'
format: uuid
evidence:
type: array
items:
$ref: '#/components/schemas/IssueEvidence'
description: Calls / chats attached as evidence
createdAt:
type: string
updatedAt:
type:
- string
- 'null'
required:
- id
- organizationId
- projectId
- alertId
- source
- title
- summary
- severity
- status
- fingerprint
- eventCount
- lastEventAt
- openedAt
- resolvedAt
- assigneeUserId
- evidence
- createdAt
- updatedAt
description: An issue surfaced on the Roark Issues page
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT