{"openapi":"3.1.0","info":{"title":"Meraki Usage Summary (BYOK) API","version":"0.1.0","description":"Meraki Usage Summary (BYOK) lets an AI assistant read your own Meraki Usage Summary data through the Meraki Usage Summary API with a key you supply (Meraki Dashboard API key (Organization > API & Webhooks)). Read-only: 8 tools (get_top_appliances_by_utilization, get_top_devices_by_usage, get_top_device_models_by_usage, get_top_ssids_by_usage, get_top_applications_by_usage,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-meraki-usage-summary.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-meraki-usage-summary/docs"},"termsOfService":"https://connectorbay.com/byok-meraki-usage-summary/terms"},"servers":[{"url":"https://byok-meraki-usage-summary.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-meraki-usage-summary/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_top_appliances_by_utilization":{"post":{"operationId":"get_top_appliances_by_utilization","summary":"List the top appliances of an organization by utilization over a window, with network, name, MAC, serial, model and aver","description":"List the top appliances of an organization by utilization over a window, with network, name, MAC, serial, model and average utilization. Use for \"Which Meraki appliances are the most heavily utilized\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"device_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device Tag"},"quantity":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50, default 10).","title":"Quantity"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"},"t0":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as ISO 8601.","title":"T0"},"t1":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as ISO 8601; at most 186 days after t0.","title":"T1"},"timespan":{"anyOf":[{"maximum":16070400,"minimum":1,"type":"number"},{"type":"null"}],"default":null,"description":"Window length in seconds, at most 186 days (some reports need at least 8 hours). Default 1 day.","title":"Timespan"}},"required":["organization_id"],"title":"get_top_appliances_by_utilizationArguments","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_top_devices_by_usage":{"post":{"operationId":"get_top_devices_by_usage","summary":"List the top devices of an organization by data usage over a window, with name, model, serial, MAC, device family, netwo","description":"List the top devices of an organization by data usage over a window, with name, model, serial, MAC, device family, network, usage and client counts. Use for \"Which Meraki devices carried the most traffic last week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"device_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device Tag"},"quantity":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50, default 10).","title":"Quantity"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"},"t0":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as ISO 8601.","title":"T0"},"t1":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as ISO 8601; at most 186 days after t0.","title":"T1"},"timespan":{"anyOf":[{"maximum":16070400,"minimum":1,"type":"number"},{"type":"null"}],"default":null,"description":"Window length in seconds, at most 186 days (some reports need at least 8 hours). Default 1 day.","title":"Timespan"}},"required":["organization_id"],"title":"get_top_devices_by_usageArguments","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_top_device_models_by_usage":{"post":{"operationId":"get_top_device_models_by_usage","summary":"List the top device hardware models of an organization by data usage over a window, with model, device count and total a","description":"List the top device hardware models of an organization by data usage over a window, with model, device count and total and average usage. Use for \"Which Meraki hardware models carry the most traffic\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"device_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device Tag"},"quantity":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50, default 10).","title":"Quantity"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"},"t0":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as ISO 8601.","title":"T0"},"t1":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as ISO 8601; at most 186 days after t0.","title":"T1"},"timespan":{"anyOf":[{"maximum":16070400,"minimum":1,"type":"number"},{"type":"null"}],"default":null,"description":"Window length in seconds, at most 186 days (some reports need at least 8 hours). Default 1 day.","title":"Timespan"}},"required":["organization_id"],"title":"get_top_device_models_by_usageArguments","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_top_ssids_by_usage":{"post":{"operationId":"get_top_ssids_by_usage","summary":"List the top SSIDs of an organization by data usage over a window, with name, usage and client counts. Use for \"Which SS","description":"List the top SSIDs of an organization by data usage over a window, with name, usage and client counts. Use for \"Which SSIDs use the most data in my Meraki organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"device_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device Tag"},"quantity":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50, default 10).","title":"Quantity"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"},"t0":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as ISO 8601.","title":"T0"},"t1":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as ISO 8601; at most 186 days after t0.","title":"T1"},"timespan":{"anyOf":[{"maximum":16070400,"minimum":1,"type":"number"},{"type":"null"}],"default":null,"description":"Window length in seconds, at most 186 days (some reports need at least 8 hours). Default 1 day.","title":"Timespan"}},"required":["organization_id"],"title":"get_top_ssids_by_usageArguments","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_top_applications_by_usage":{"post":{"operationId":"get_top_applications_by_usage","summary":"List the top applications by data usage across the organization over a window, with total, downstream and upstream usage","description":"List the top applications by data usage across the organization over a window, with total, downstream and upstream usage and share. Use for \"Which applications use the most bandwidth in my Meraki organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"network_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this network id.","title":"Network Id"},"device":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"quantity":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50, default 10).","title":"Quantity"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"},"t0":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as ISO 8601.","title":"T0"},"t1":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as ISO 8601; at most 186 days after t0.","title":"T1"},"timespan":{"anyOf":[{"maximum":16070400,"minimum":1,"type":"number"},{"type":"null"}],"default":null,"description":"Window length in seconds, at most 186 days (some reports need at least 8 hours). Default 1 day.","title":"Timespan"}},"required":["organization_id"],"title":"get_top_applications_by_usageArguments","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_top_application_categories_by_usage":{"post":{"operationId":"get_top_application_categories_by_usage","summary":"List the top application categories by data usage across the organization over a window, with total, downstream and upst","description":"List the top application categories by data usage across the organization over a window, with total, downstream and upstream usage and share. Use for \"Which application categories use the most bandwidth in my Meraki organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"network_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this network id.","title":"Network Id"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"device_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device Tag"},"quantity":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50, default 10).","title":"Quantity"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"},"t0":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as ISO 8601.","title":"T0"},"t1":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as ISO 8601; at most 186 days after t0.","title":"T1"},"timespan":{"anyOf":[{"maximum":16070400,"minimum":1,"type":"number"},{"type":"null"}],"default":null,"description":"Window length in seconds, at most 186 days (some reports need at least 8 hours). Default 1 day.","title":"Timespan"}},"required":["organization_id"],"title":"get_top_application_categories_by_usageArguments","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_top_switches_by_energy_usage":{"post":{"operationId":"get_top_switches_by_energy_usage","summary":"List the top switches of an organization by energy usage over a window, with network, name, MAC, model and total usage. ","description":"List the top switches of an organization by energy usage over a window, with network, name, MAC, model and total usage. Use for \"Which Meraki switches use the most power\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"device_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device Tag"},"quantity":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50, default 10).","title":"Quantity"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"},"t0":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as ISO 8601.","title":"T0"},"t1":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as ISO 8601; at most 186 days after t0.","title":"T1"},"timespan":{"anyOf":[{"maximum":16070400,"minimum":1,"type":"number"},{"type":"null"}],"default":null,"description":"Window length in seconds, at most 186 days (some reports need at least 8 hours). Default 1 day.","title":"Timespan"}},"required":["organization_id"],"title":"get_top_switches_by_energy_usageArguments","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_networks_by_status":{"post":{"operationId":"list_networks_by_status","summary":"List the networks of an organization with overall status (online, alerting, offline or dormant), device counts by produc","description":"List the networks of an organization with overall status (online, alerting, offline or dormant), device counts by product type, client counts and usage. Use for \"Which of my Meraki networks are offline or alerting\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from the Meraki organizations list, for example '549236'.","maxLength":40,"title":"Organization Id","type":"string"},"per_page":{"anyOf":[{"maximum":5000,"minimum":3,"type":"integer"},{"type":"null"}],"default":100,"description":"How many networks to return, 3 to 5000.","title":"Per Page"},"network_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only networks with exactly this tag.","title":"Network Tag"},"device_tag":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only devices with exactly this tag.","title":"Device Tag"},"ssid_name":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this SSID name.","title":"Ssid Name"},"usage_uplink":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only usage on this uplink, for example wan1 or cellular.","title":"Usage Uplink"}},"required":["organization_id"],"title":"list_networks_by_statusArguments","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}}}}