Sigma Computing

Sigma Computing Reports API

The Reports API from Sigma Computing — 26 operation(s) for reports.

GitHub OpenAPI
Business capability
Analytics & BI Management BC-610.50

Operations 29

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/reports List the reports I can access · List reports #
Ask an LLM
“Which Sigma reports can I see, including ones in My Documents?”
“Can I leave archived reports out of the report listing?”
Tell an agent
List all the reports I have access to.
List reports, {limit} per page, excluding archived ones set to {isArchived}.
POST /v2/reports Create an empty report in a folder · Create a report #
Ask an LLM
“How do I create a new blank report for stakeholders?”
“Can I give a new report a description when I create it?”
Tell an agent
Create a new report named {name} in folder {folderId}.
Create an empty report called {name} in folder {folderId} described as {description}.
GET /v2/reports/{reportId} Get a report's details and metadata · Get a report #
Ask an LLM
“What is the URL and folder path of a specific report?”
“Where can I see the name and metadata of one report by its ID?”
Tell an agent
Show me the details of report {reportId}.
Get the URL and path for report {reportId}.
GET /v2/reports/{reportId}/columns List columns across every element of a report · List columns for all elements in a report #
Ask an LLM
“Which columns are used across all the data elements in a report?”
“Can I get every column in a report at once instead of element by element?”
Tell an agent
List all columns across every element in report {reportId}.
Page through the report-wide column list for {reportId}, {pageSize} at a time.
GET /v2/reports/{reportId}/controls List the control elements in a report · List report controls #
Ask an LLM
“What filters and input controls does a report offer its viewers?”
“Can I see the controls on a specific tagged version of a report?”
Tell an agent
List the controls in report {reportId}.
Show the control elements of report {reportId} for version tag {tagName}.
POST /v2/reports/{reportId}/copy Duplicate a report into a folder · Duplicate a report #
Ask an LLM
“How do I make a copy of an existing report?”
“Can I duplicate a report into a different folder under a new name?”
Tell an agent
Duplicate report {reportId} as {name} into folder {destinationFolderId}.
Copy the current report {reportId} to folder {destinationFolderId} and call it {name}.
GET /v2/reports/{reportId}/elements List all elements in a report · List elements in a report #
Ask an LLM
“What charts, tables and controls make up a report?”
“Can I list every element of a report regardless of page?”
Tell an agent
List every element in report {reportId}.
Show all charts and tables in report {reportId} for tag {tagName}.
GET /v2/reports/{reportId}/elements/{elementId}/columns List columns of one report element · List columns for a report element #
Ask an LLM
“What columns and formulas does a single chart or table in a report use?”
“Can I see the formula behind each column of one report element?”
Tell an agent
List the columns of element {elementId} in report {reportId}.
Show column names and formulas for element {elementId} of report {reportId}.
GET /v2/reports/{reportId}/elements/{elementId}/query Get the SQL behind a report element · Get the SQL query for a report element #
Ask an LLM
“How can I see the SQL a report chart runs against the warehouse?”
“What query produces the data for one element in my report?”
Tell an agent
Get the SQL query for element {elementId} in report {reportId}.
Show me how element {elementId} of report {reportId} is transformed in SQL.
POST /v2/reports/{reportId}/export Export a report or page as a PDF · Export data from a report #
Ask an LLM
“How do I export a report to PDF through the API?”
“Can I export just one page of a report instead of the whole thing?”
Tell an agent
Export report {reportId} as a PDF.
Start a PDF export of report {reportId} with a timeout of {timeout}.
POST /v2/reports/{reportId}/grants Share a report with users or teams · Grant permissions on a report to users or teams #
Ask an LLM
“How do I give a team access to a report?”
“Can I grant specific document permissions on one report to several users?”
Tell an agent
Grant {grants} permissions on report {reportId}.
Share report {reportId} with these users and teams: {grants}.
DELETE /v2/reports/{reportId}/grants/{grantId} Revoke a permission grant on a report · Delete a report grant #
Ask an LLM
“How do I take away someone's access to a report?”
“What happens to users when a report grant is deleted?”
Tell an agent destructive · confirm first
Remove grant {grantId} from report {reportId}.
Revoke report {reportId} access given by grant {grantId}.
GET /v2/reports/{reportId}/lineage Show data lineage for a whole report · List lineage for a report #
Ask an LLM
“How are the data elements in a report connected to each other?”
“Can I see the dependency tree for an entire report?”
Tell an agent
List the lineage for report {reportId}.
Map the dependencies between all elements in report {reportId}.
GET /v2/reports/{reportId}/lineage/elements/{elementId} Show lineage of one report element · List lineage of a report element #
Ask an LLM
“Where does the data in one specific report chart come from?”
“What does a single report element depend on upstream?”
Tell an agent
Show the lineage of element {elementId} in report {reportId}.
Trace the upstream dependencies of report element {elementId} in {reportId}.
GET /v2/reports/{reportId}/pages List the pages in a report · List report pages #
Ask an LLM
“How many pages does a report have and what are they called?”
“Can I list report pages for a particular version tag?”
Tell an agent
List the pages in report {reportId}.
Show the pages of report {reportId} as of tag {tag}.
GET /v2/reports/{reportId}/pages/{pageId}/elements List elements on one report page · List elements in a report page #
Ask an LLM
“Which charts and tables sit on a specific page of a report?”
“Can I get only the elements from a single report page?”
Tell an agent
List the elements on page {pageId} of report {reportId}.
Show what is on report page {pageId} in {reportId}.
GET /v2/reports/{reportId}/queries List all SQL queries in a report · List SQL queries in a report #
Ask an LLM
“Can I pull every SQL query a report runs in one call?”
“What SQL statements are stored in a report?”
Tell an agent
List all SQL queries in report {reportId}.
Dump the stored SQL for every element of report {reportId}.
GET /v2/reports/{reportId}/schedules List scheduled exports of a report · List scheduled report exports #
Ask an LLM
“Which scheduled exports are set up on a report?”
“How can I audit when a report is automatically sent out?”
Tell an agent
List the scheduled exports for report {reportId}.
Show report {reportId}'s export schedules, {limit} per page.
POST /v2/reports/{reportId}/schedules Schedule a recurring report export · Add report schedule #
Ask an LLM
“How do I schedule a report to be exported automatically?”
“Can I set a report to deliver on a timed schedule to a target?”
Tell an agent
Schedule report {reportId} to export to {target} on {schedule}.
Add a scheduled export for report {reportId} with config {configV2}, target {target} and schedule {schedule}.
PATCH /v2/reports/{reportId}/schedules/{scheduleId} Change or suspend a report's export schedule · Update a report schedule #
Ask an LLM
“How do I change the timing of an existing scheduled report export?”
“Can I suspend a report schedule without deleting it?”
Tell an agent
Change schedule {scheduleId} on report {reportId} to run on {schedule}.
Apply suspension action {suspensionAction} to schedule {scheduleId} of report {reportId}.
DELETE /v2/reports/{reportId}/schedules/{scheduleId} Delete a scheduled report export · Delete a scheduled export for a report #
Ask an LLM
“How do I stop a report from being exported on a schedule?”
“Can I remove one scheduled export while keeping the report?”
Tell an agent destructive · confirm first
Delete schedule {scheduleId} from report {reportId}.
Stop the scheduled export {scheduleId} on report {reportId}.
POST /v2/reports/{reportId}/send Send a report to recipients or destinations now · Export a report #
Ask an LLM
“How do I send a report to a Slack channel or email recipients right away?”
“Can a report be delivered to Google Drive, cloud storage or a webhook?”
Tell an agent
Send report {reportId} to {targets} with attachments {attachments} and config {config}.
Deliver report {reportId} now to {targets} as {attachments} using {config}.
GET /v2/reports/{reportId}/sources List the data sources behind a report · List report sources #
Ask an LLM
“Which tables and data models does a report pull its data from?”
“What data sources does my report depend on?”
Tell an agent
List the data sources of report {reportId}.
Show which tables feed report {reportId}.
POST /v2/reports/{reportId}/swapSources Swap the data sources a report uses · Swap report data sources #
Ask an LLM
“How do I point a report at a different table or data model?”
“Can I replace every source in a report in one request?”
Tell an agent
Swap the sources of report {reportId} using mapping {sourceMapping}.
Repoint report {reportId} to new tables per {sourceMapping}.
POST /v2/reports/{reportId}/tag/{versionTag}/copy Duplicate a tagged version of a report · Duplicate a tagged report #
Ask an LLM
“How do I create a new report from a tagged version like Production?”
“Can I copy the tagged release of a report rather than the latest draft?”
Tell an agent
Copy report {reportId} at tag {versionTag} as {name} into folder {destinationFolderId}.
Make a new report named {name} in {destinationFolderId} from the {versionTag} version of {reportId}.
GET /v2/reports/{reportId}/tags List version tags on a report · List tags for a report #
Ask an LLM
“Which version tags have been applied to a report?”
“Is a report tagged for production yet?”
Tell an agent
List the version tags on report {reportId}.
Show tag metadata for report {reportId}.
DELETE /v2/reports/{reportId}/tags/{tagId} Remove a version tag from a report · Remove a tag from a report #
Ask an LLM
“How do I remove an outdated version tag from a report?”
“Can I untag a report without deleting the report?”
Tell an agent destructive · confirm first
Remove tag {tagId} from report {reportId}.
Untag report {reportId} by deleting version tag {tagId}.
GET /v2/reports/{reportId}/version-history Get a report's version history · Get version history for a report #
Ask an LLM
“How can I see the past versions of a report?”
“Does a report's history show which versions were tagged?”
Tell an agent
Get the version history of report {reportId}.
Show report {reportId}'s previous versions, {pageSize} at a time.
POST /v2/reports/tag Apply a version tag to a report · Tag a report #
Ask an LLM
“How do I tag a report version for release?”
“Can I make a tag the default version of a report when I apply it?”
Tell an agent
Tag report {reportId} with {tagName}.
Tag version {reportVersion} of report {reportId} as {tagName}.

Documentation

📖
Documentation
https://help.sigmacomputing.com/docs/get-started-with-sigmas-api
📖
APIReference
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
GettingStarted
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/authentication/sigma-computing-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/rate-limits/sigma-computing-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-reports-api-openapi.yml

Other Resources

🔗
Examples
https://help.sigmacomputing.com/recipes
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/scopes/sigma-computing-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conventions/sigma-computing-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/errors/sigma-computing-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/data-model/sigma-computing-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/asyncapi/sigma-computing-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conformance/sigma-computing-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/lifecycle/sigma-computing-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sigma-computing:sigma-computing-reports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sigma-computing-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Reports API
  version: '1.0'
  description: 'Operations tagged reports across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sigmacomputing.com
  description: Server for GCP (US) hosted organizations
- url: https://api.sa.gcp.sigmacomputing.com
  description: Server for GCP (KSA) hosted organizations
- url: https://aws-api.sigmacomputing.com
  description: Server for AWS US (West) hosted organizations
- url: https://api.us-a.aws.sigmacomputing.com
  description: Server for AWS US (East) hosted organizations
- url: https://api.ca.aws.sigmacomputing.com
  description: Server for AWS Canada hosted organizations
- url: https://api.eu.aws.sigmacomputing.com
  description: Server for AWS Europe hosted organizations
- url: https://api.au.aws.sigmacomputing.com
  description: Server for AWS Australia and APAC hosted organizations
- url: https://api.uk.aws.sigmacomputing.com
  description: Server for AWS UK hosted organizations
- url: https://api.us.azure.sigmacomputing.com
  description: Server for Azure US hosted organizations
- url: https://api.eu.azure.sigmacomputing.com
  description: Server for Azure Europe hosted organizations
- url: https://api.ca.azure.sigmacomputing.com
  description: Server for Azure Canada hosted organizations
- url: https://api.uk.azure.sigmacomputing.com
  description: Server for Azure United Kingdom hosted organizations
- url: https://api.au.azure.sigmacomputing.com
  description: Server for Azure Australia hosted organizations
tags:


# --- truncated at 32 KB (1017 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-reports-api-openapi.yml