{"openapi":"3.1.0","info":{"title":"Bird SMS Stats (BYOK) API","version":"0.1.0","description":"Bird SMS Stats (BYOK) lets an AI assistant read your own Bird SMS Stats data through the Bird SMS Stats API with a key you supply (Bird workspace API key (bk_...)). Read-only: 12 tools (get_sms_stats_daily, get_sms_stats_hourly, get_sms_stats_by_carrier, get_sms_stats_by_country, get_sms_stats_by_error_code, get_sms_stats_by_originator, get_sms_stats_by_status, get_sms_stats_by_tag,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bird-sms-stats.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bird-sms-stats/docs"},"termsOfService":"https://connectorbay.com/byok-bird-sms-stats/terms"},"servers":[{"url":"https://byok-bird-sms-stats.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bird-sms-stats/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_sms_stats_daily":{"post":{"operationId":"get_sms_stats_daily","summary":"Get outbound SMS counts per day (accepted, sent, delivered, undelivered, failed, rejected, expired) with rates, optional","description":"Get outbound SMS counts per day (accepted, sent, delivered, undelivered, failed, rejected, expired) with rates, optionally for one sender, country, category or carrier (only one filter at a time). Use for \"How many SMS did I send each day last week on Bird and how many were delivered\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"originator":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only this sender (originator) address.","title":"Originator"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only this destination country, ISO 3166-1 alpha-2.","title":"Country"},"category":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this category.","title":"Category"},"carrier":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only this delivery carrier.","title":"Carrier"}},"required":["region"],"title":"get_sms_stats_dailyArguments","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_sms_stats_hourly":{"post":{"operationId":"get_sms_stats_hourly","summary":"Get outbound SMS counts per hour with delivery rates, optionally for one sender, country, category or carrier (only one ","description":"Get outbound SMS counts per hour with delivery rates, optionally for one sender, country, category or carrier (only one filter at a time). Use for \"How did Bird SMS delivery look hour by hour this morning\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window as an ISO 8601 instant, for example 2026-10-15T00:00:00Z (rounded down to the hour).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as an ISO 8601 instant (rounded down to the hour).","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"originator":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only this sender (originator) address.","title":"Originator"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only this destination country, ISO 3166-1 alpha-2.","title":"Country"},"category":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this category.","title":"Category"},"carrier":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only this delivery carrier.","title":"Carrier"}},"required":["region"],"title":"get_sms_stats_hourlyArguments","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_sms_stats_by_carrier":{"post":{"operationId":"get_sms_stats_by_carrier","summary":"Compare outbound SMS delivery and latency across the carriers that handled your messages, ranked by a chosen metric. Use","description":"Compare outbound SMS delivery and latency across the carriers that handled your messages, ranked by a chosen metric. Use for \"Which carrier has the worst SMS delivery rate on Bird\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"sort":{"anyOf":[{"enum":["accepted","sent","delivered","undelivered","failed","rejected","expired","delivery_rate","failure_rate"],"type":"string"},{"type":"null"}],"default":"accepted","description":"Metric to rank rows by, descending: accepted, sent, delivered, undelivered, failed, rejected, expired, delivery_rate or failure_rate.","title":"Sort"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum carrier rows to return, ranked by the sort metric (1 to 200, default 50).","title":"Limit"},"include_trend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to add a short per-bucket count series to each row (needs a limit of 50 or fewer and a window of at most 90 days).","title":"Include Trend"}},"required":["region"],"title":"get_sms_stats_by_carrierArguments","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_sms_stats_by_country":{"post":{"operationId":"get_sms_stats_by_country","summary":"Compare outbound SMS delivery and latency by destination country, ranked by a chosen metric. Use for \"Which countries ha","description":"Compare outbound SMS delivery and latency by destination country, ranked by a chosen metric. Use for \"Which countries have the lowest SMS delivery rate on Bird\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"sort":{"anyOf":[{"enum":["accepted","sent","delivered","undelivered","failed","rejected","expired","delivery_rate","failure_rate"],"type":"string"},{"type":"null"}],"default":"accepted","description":"Metric to rank rows by, descending: accepted, sent, delivered, undelivered, failed, rejected, expired, delivery_rate or failure_rate.","title":"Sort"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum country rows to return, ranked by the sort metric (1 to 200, default 50).","title":"Limit"},"include_trend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to add a short per-bucket count series to each row (needs a limit of 50 or fewer and a window of at most 90 days).","title":"Include Trend"}},"required":["region"],"title":"get_sms_stats_by_countryArguments","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_sms_stats_by_error_code":{"post":{"operationId":"get_sms_stats_by_error_code","summary":"Count outbound SMS failures by error code, ranked by a chosen metric. Use for \"What are the most common SMS error codes ","description":"Count outbound SMS failures by error code, ranked by a chosen metric. Use for \"What are the most common SMS error codes on Bird this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"sort":{"anyOf":[{"enum":["accepted","sent","delivered","undelivered","failed","rejected","expired","delivery_rate","failure_rate"],"type":"string"},{"type":"null"}],"default":"accepted","description":"Metric to rank rows by, descending: accepted, sent, delivered, undelivered, failed, rejected, expired, delivery_rate or failure_rate.","title":"Sort"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum error-code rows to return, ranked by the sort metric (1 to 200, default 50).","title":"Limit"},"include_trend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to add a short per-bucket count series to each row (needs a limit of 50 or fewer and a window of at most 90 days).","title":"Include Trend"}},"required":["region"],"title":"get_sms_stats_by_error_codeArguments","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_sms_stats_by_originator":{"post":{"operationId":"get_sms_stats_by_originator","summary":"Compare outbound SMS delivery by sender (originator) address, ranked by a chosen metric. Use for \"Which sender ID has th","description":"Compare outbound SMS delivery by sender (originator) address, ranked by a chosen metric. Use for \"Which sender ID has the best SMS delivery rate on Bird\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"sort":{"anyOf":[{"enum":["accepted","sent","delivered","undelivered","failed","rejected","expired","delivery_rate","failure_rate"],"type":"string"},{"type":"null"}],"default":"accepted","description":"Metric to rank rows by, descending: accepted, sent, delivered, undelivered, failed, rejected, expired, delivery_rate or failure_rate.","title":"Sort"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum originator rows to return, ranked by the sort metric (1 to 200, default 50).","title":"Limit"},"include_trend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to add a short per-bucket count series to each row (needs a limit of 50 or fewer and a window of at most 90 days).","title":"Include Trend"}},"required":["region"],"title":"get_sms_stats_by_originatorArguments","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_sms_stats_by_status":{"post":{"operationId":"get_sms_stats_by_status","summary":"Count outbound SMS messages by lifecycle status for a period. Use for \"How many SMS are in each status on Bird this week","description":"Count outbound SMS messages by lifecycle status for a period. Use for \"How many SMS are in each status on Bird this week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"}},"required":["region"],"title":"get_sms_stats_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}},"/v1/tools/get_sms_stats_by_tag":{"post":{"operationId":"get_sms_stats_by_tag","summary":"Compare outbound SMS delivery by message tag, ranked by a chosen metric. Use for \"How did the SMS campaign tagged promo ","description":"Compare outbound SMS delivery by message tag, ranked by a chosen metric. Use for \"How did the SMS campaign tagged promo perform on Bird\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"sort":{"anyOf":[{"enum":["accepted","sent","delivered","undelivered","failed","rejected","expired","delivery_rate","failure_rate"],"type":"string"},{"type":"null"}],"default":"accepted","description":"Metric to rank rows by, descending: accepted, sent, delivered, undelivered, failed, rejected, expired, delivery_rate or failure_rate.","title":"Sort"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum tag rows to return, ranked by the sort metric (1 to 200, default 50).","title":"Limit"},"include_trend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to add a short per-bucket count series to each row (needs a limit of 50 or fewer and a window of at most 90 days).","title":"Include Trend"}},"required":["region"],"title":"get_sms_stats_by_tagArguments","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_sms_stats_by_category":{"post":{"operationId":"get_sms_stats_by_category","summary":"Compare outbound SMS delivery by message category, ranked by a chosen metric. Use for \"Which SMS category has the most f","description":"Compare outbound SMS delivery by message category, ranked by a chosen metric. Use for \"Which SMS category has the most failures on Bird\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"sort":{"anyOf":[{"enum":["accepted","sent","delivered","undelivered","failed","rejected","expired","delivery_rate","failure_rate"],"type":"string"},{"type":"null"}],"default":"accepted","description":"Metric to rank rows by, descending: accepted, sent, delivered, undelivered, failed, rejected, expired, delivery_rate or failure_rate.","title":"Sort"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum category rows to return, ranked by the sort metric (1 to 200, default 50).","title":"Limit"},"include_trend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to add a short per-bucket count series to each row (needs a limit of 50 or fewer and a window of at most 90 days).","title":"Include Trend"}},"required":["region"],"title":"get_sms_stats_by_categoryArguments","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_sms_inbound_stats_summary":{"post":{"operationId":"get_sms_inbound_stats_summary","summary":"Get the number of inbound SMS received in a period with a comparison to the previous period. Use for \"How many SMS did I","description":"Get the number of inbound SMS received in a period with a comparison to the previous period. Use for \"How many SMS did I receive on Bird this month compared with last month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the window: a day (YYYY-MM-DD) or an ISO 8601 instant.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window in the same form (default: today).","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"}},"required":["region"],"title":"get_sms_inbound_stats_summaryArguments","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_sms_inbound_stats_daily":{"post":{"operationId":"get_sms_inbound_stats_daily","summary":"Get the number of inbound SMS received per day. Use for \"How many inbound SMS arrived each day last week on Bird\".","description":"Get the number of inbound SMS received per day. Use for \"How many inbound SMS arrived each day last week on Bird\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"}},"required":["region"],"title":"get_sms_inbound_stats_dailyArguments","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_sms_inbound_stats_by_country":{"post":{"operationId":"get_sms_inbound_stats_by_country","summary":"Get inbound SMS volume by sender country, ranked by volume. Use for \"Which countries send me the most inbound SMS on Bir","description":"Get inbound SMS volume by sender country, ranked by volume. Use for \"Which countries send me the most inbound SMS on Bird\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Region your Bird organization is hosted in: us1 or eu1 (the key prefix bk_us1_ or bk_eu1_ shows it).","enum":["us1","eu1"],"title":"Region","type":"string"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the window, YYYY-MM-DD, counted in the timezone below (default: 30 days before the end day).","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the window (inclusive), YYYY-MM-DD (default: today). The window may not exceed 365 days.","title":"Date To"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"IANA timezone used to group days, for example Asia/Kolkata (default UTC).","title":"Timezone"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum country rows to return, ranked by the sort metric (1 to 200, default 50).","title":"Limit"}},"required":["region"],"title":"get_sms_inbound_stats_by_countryArguments","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}}}}