{"openapi":"3.1.0","info":{"title":"Holistics (BYOK) API","version":"0.1.0","description":"Holistics (BYOK) lets an AI assistant read your own Holistics data through the Holistics API with a key you supply (Holistics API key). Read-only: 11 tools (get_me, list_dashboards, get_dashboard, list_data_schedules, list_data_alerts, get_job, list_job_queues, get_data_source, list_users, list_groups, list_tags). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-holistics.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-holistics/docs"},"termsOfService":"https://connectorbay.com/byok-holistics/terms"},"servers":[{"url":"https://byok-holistics.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-holistics/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_me":{"post":{"operationId":"get_me","summary":"Show the Holistics user the API key belongs to: name, email, role and sign-in times. Use for \"Which Holistics user is my","description":"Show the Holistics user the API key belongs to: name, email, role and sign-in times. Use for \"Which Holistics user is my API key for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"}},"required":["region"],"title":"get_meArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dashboards":{"post":{"operationId":"list_dashboards","summary":"List dashboards with title, owner, category, version, URL and tags. Widgets and filters are left out. Use for \"Which das","description":"List dashboards with title, owner, category, version, URL and tags. Widgets and filters are left out. Use for \"Which dashboards do we have in Holistics\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from cursors.next of the previous answer, to get the next page.","title":"After"},"sort":{"anyOf":[{"enum":["natural","id_asc","id_desc"],"type":"string"},{"type":"null"}],"default":"natural","description":"Order: natural, id_asc or id_desc.","title":"Sort"}},"required":["region"],"title":"list_dashboardsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_dashboard":{"post":{"operationId":"get_dashboard","summary":"Get one dashboard by id: title, owner, category, version, URL and tags. Use for \"Show details of Holistics dashboard 1\".","description":"Get one dashboard by id: title, owner, category, version, URL and tags. Use for \"Show details of Holistics dashboard 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"id":{"description":"Dashboard id (integer).","title":"Id","type":"integer"}},"required":["region","id"],"title":"get_dashboardArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_data_schedules":{"post":{"operationId":"list_data_schedules","summary":"List scheduled deliveries of dashboards and reports with title, source, repeat rule and paused or archived state. Use fo","description":"List scheduled deliveries of dashboards and reports with title, source, repeat rule and paused or archived state. Use for \"Which Holistics report schedules are paused\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from cursors.next of the previous answer, to get the next page.","title":"After"},"search_term":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search schedules by title.","title":"Search Term"},"source_type":{"anyOf":[{"enum":["QueryReport","Dashboard"],"type":"string"},{"type":"null"}],"default":null,"description":"Only schedules of this source type.","title":"Source Type"},"source_id":{"anyOf":[{"maximum":2000000000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only schedules of the dashboard or report with this id.","title":"Source Id"}},"required":["region"],"title":"list_data_schedulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_data_alerts":{"post":{"operationId":"list_data_alerts","summary":"List data alerts with title, source, destination type and schedule state. Use for \"Which data alerts are set up in Holis","description":"List data alerts with title, source, destination type and schedule state. Use for \"Which data alerts are set up in Holistics\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from cursors.next of the previous answer, to get the next page.","title":"After"},"search_term":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search alerts by title.","title":"Search Term"},"dest_type":{"anyOf":[{"enum":["EmailDest","SlackDest"],"type":"string"},{"type":"null"}],"default":null,"description":"Only alerts with this destination type.","title":"Dest Type"}},"required":["region"],"title":"list_data_alertsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_job":{"post":{"operationId":"get_job","summary":"Get the status of a background job (export, schedule run, data model persistence): start and end time, status and last e","description":"Get the status of a background job (export, schedule run, data model persistence): start and end time, status and last error. Use for \"Did Holistics job 123 finish and did it fail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"id":{"description":"Job id (integer).","title":"Id","type":"integer"}},"required":["region","id"],"title":"get_jobArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_job_queues":{"post":{"operationId":"list_job_queues","summary":"Show Holistics job queues with total and busy workers. Use for \"Are Holistics job workers busy\".","description":"Show Holistics job queues with total and busy workers. Use for \"Are Holistics job workers busy\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"}},"required":["region"],"title":"list_job_queuesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_data_source":{"post":{"operationId":"get_data_source","summary":"Get a connected data source: name, database type, timezone, query timeout and whether it is the default or a sample. Cre","description":"Get a connected data source: name, database type, timezone, query timeout and whether it is the default or a sample. Credentials are not part of the answer. Use for \"What database type is Holistics data source 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"id":{"description":"Data source id (integer).","title":"Id","type":"integer"}},"required":["region","id"],"title":"get_data_sourceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_users":{"post":{"operationId":"list_users","summary":"List users with name, email, role, activation and last sign-in time. Use for \"Who has access to Holistics and with which","description":"List users with name, email, role, activation and last sign-in time. Use for \"Who has access to Holistics and with which role\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from cursors.next of the previous answer, to get the next page.","title":"After"},"search_term":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search by email, name, initials or group name.","title":"Search Term"},"role":{"anyOf":[{"enum":["user","explorer","analyst","admin","growth_admin","it_admin"],"type":"string"},{"type":"null"}],"default":null,"description":"Only users with this role.","title":"Role"},"status":{"anyOf":[{"enum":["active","deleted","pending"],"type":"string"},{"type":"null"}],"default":null,"description":"Only users with this status.","title":"Status"}},"required":["region"],"title":"list_usersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_groups":{"post":{"operationId":"list_groups","summary":"List user groups with id, name and member user ids. Use for \"Which user groups exist in Holistics\".","description":"List user groups with id, name and member user ids. Use for \"Which user groups exist in Holistics\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from cursors.next of the previous answer, to get the next page.","title":"After"}},"required":["region"],"title":"list_groupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tags":{"post":{"operationId":"list_tags","summary":"List the production tags with name, description and color. Use for \"Which tags are defined in Holistics\".","description":"List the production tags with name, description and color. Use for \"Which tags are defined in Holistics\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Holistics region of the account: 'us', 'eu' or 'secure' (the Asia-Pacific region, secure.holistics.io).","enum":["us","eu","secure"],"title":"Region","type":"string"}},"required":["region"],"title":"list_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}