{"openapi":"3.1.0","info":{"title":"Adapty (BYOK) API","version":"0.1.0","description":"Adapty (BYOK) lets an AI assistant read your own Adapty data through the Adapty API with a key you supply (Adapty secret API key (starts with secret_)). Read-only: 7 tools (get_analytics_chart, get_cohort_data, get_conversion_data, get_funnel_data, get_ltv_data, get_retention_data, list_placements). The BYOK key travels with each request, is used for that one call only and is never stored, logged...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-adapty.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-adapty/docs"},"termsOfService":"https://connectorbay.com/byok-adapty/terms"},"servers":[{"url":"https://byok-adapty.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-adapty/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_analytics_chart":{"post":{"operationId":"get_analytics_chart","summary":"Get one subscription chart (revenue, MRR, ARR, active subscriptions, trials, refunds, installs and more) over a period, ","description":"Get one subscription chart (revenue, MRR, ARR, active subscriptions, trials, refunds, installs and more) over a period, with totals and per-bucket data. Limit 2 requests per second. Use for \"What was my Adapty MRR per month in the first quarter\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"chart_id":{"description":"Chart to return.","enum":["revenue","mrr","arr","arppu","subscriptions_active","subscriptions_new","subscriptions_renewal_cancelled","subscriptions_expired","trials_active","trials_new","trials_renewal_cancelled","trials_expired","grace_period","billing_issue","refund_events","refund_money","non_subscriptions","arpu","installs"],"title":"Chart Id","type":"string"},"date_from":{"description":"First day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date From","type":"string"},"date_to":{"description":"Last day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date To","type":"string"},"period_unit":{"anyOf":[{"enum":["day","week","month","quarter","year"],"type":"string"},{"type":"null"}],"default":"month","description":"Time bucket: day, week, month, quarter or year.","title":"Period Unit"},"date_type":{"anyOf":[{"enum":["purchase_date","profile_install_date"],"type":"string"},{"type":"null"}],"default":"purchase_date","description":"Which date counts as the joining date: purchase_date or profile_install_date.","title":"Date Type"},"segmentation":{"anyOf":[{"enum":["period","renewal_status","cancellation_reason","store_product_id","country","store","paywall_id","audience_id","placement_id","flow_id","flow_screen_id","segment_id","duration","offer_category","offer_type","offer_id","attribution_source","attribution_status","attribution_channel","attribution_campaign","attribution_adgroup","attribution_adset","attribution_creative","day","week","month","year"],"type":"string"},{"type":"null"}],"default":null,"description":"Dimension to split the data into one series per value, for example country, store or attribution_channel.","title":"Segmentation"}},"required":["chart_id","date_from","date_to"],"title":"get_analytics_chartArguments","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_cohort_data":{"post":{"operationId":"get_cohort_data","summary":"Get install-date cohort data: per cohort the installs, subscriptions, paying subscribers and revenue, proceeds and ARPU ","description":"Get install-date cohort data: per cohort the installs, subscriptions, paying subscribers and revenue, proceeds and ARPU in USD, by period. Use for \"How do my Adapty cohorts earn over their first renewals\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date_from":{"description":"First day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date From","type":"string"},"date_to":{"description":"Last day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date To","type":"string"},"period_unit":{"anyOf":[{"enum":["day","week","month","quarter","year"],"type":"string"},{"type":"null"}],"default":"month","description":"Time bucket: day, week, month, quarter or year.","title":"Period Unit"},"period_type":{"anyOf":[{"enum":["renewals","days"],"type":"string"},{"type":"null"}],"default":"renewals","description":"Columns by renewals or by days.","title":"Period Type"},"value_type":{"anyOf":[{"enum":["absolute","relative"],"type":"string"},{"type":"null"}],"default":"absolute","description":"Show absolute or relative values.","title":"Value Type"},"value_field":{"anyOf":[{"enum":["revenue","arppu","arpu","arpas","subscribers","subscriptions"],"type":"string"},{"type":"null"}],"default":"revenue","description":"Value shown: revenue, arppu, arpu, arpas, subscribers or subscriptions.","title":"Value Field"},"accounting_type":{"anyOf":[{"enum":["revenue","proceeds","net_revenue"],"type":"string"},{"type":"null"}],"default":"revenue","description":"Money basis: revenue, proceeds or net_revenue.","title":"Accounting Type"},"prediction_months":{"anyOf":[{"enum":[3,6,9,12,18,24],"type":"integer"},{"type":"null"}],"default":12,"description":"Months of prediction to include.","title":"Prediction Months"}},"required":["date_from","date_to"],"title":"get_cohort_dataArguments","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_conversion_data":{"post":{"operationId":"get_conversion_data","summary":"Get the conversion rate between two subscription states, for example from paid to the sixth month, over a period. Use fo","description":"Get the conversion rate between two subscription states, for example from paid to the sixth month, over a period. Use for \"What share of my Adapty paying users reach month six\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date_from":{"description":"First day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date From","type":"string"},"date_to":{"description":"Last day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date To","type":"string"},"to_period":{"description":"Target subscription state, for example '6+' for more than six renewals.","maxLength":200,"title":"To Period","type":"string"},"from_period":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Starting subscription state of the conversion, for example '1' (first payment) or leave empty for none.","title":"From Period"},"period_unit":{"anyOf":[{"enum":["day","week","month","quarter","year"],"type":"string"},{"type":"null"}],"default":"month","description":"Time bucket: day, week, month, quarter or year.","title":"Period Unit"},"segmentation":{"anyOf":[{"enum":["period","renewal_status","cancellation_reason","store_product_id","country","store","paywall_id","audience_id","placement_id","flow_id","flow_screen_id","segment_id","duration","offer_category","offer_type","offer_id","attribution_source","attribution_status","attribution_channel","attribution_campaign","attribution_adgroup","attribution_adset","attribution_creative","day","week","month","year"],"type":"string"},{"type":"null"}],"default":null,"description":"Dimension to split the data into one series per value, for example country, store or attribution_channel.","title":"Segmentation"}},"required":["date_from","date_to","to_period"],"title":"get_conversion_dataArguments","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_funnel_data":{"post":{"operationId":"get_funnel_data","summary":"Get the purchase funnel (install, paywall shown, trial, paid and so on) with counts, relative values and drop-off per st","description":"Get the purchase funnel (install, paywall shown, trial, paid and so on) with counts, relative values and drop-off per stage. Use for \"Where do users drop off in my Adapty purchase funnel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date_from":{"description":"First day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date From","type":"string"},"date_to":{"description":"Last day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date To","type":"string"},"show_value_as":{"anyOf":[{"enum":["absolute","relative","both"],"type":"string"},{"type":"null"}],"default":"absolute","description":"Show absolute counts, relative percentages or both.","title":"Show Value As"},"segmentation":{"anyOf":[{"enum":["period","renewal_status","cancellation_reason","store_product_id","country","store","paywall_id","audience_id","placement_id","flow_id","flow_screen_id","segment_id","duration","offer_category","offer_type","offer_id","attribution_source","attribution_status","attribution_channel","attribution_campaign","attribution_adgroup","attribution_adset","attribution_creative","day","week","month","year"],"type":"string"},{"type":"null"}],"default":null,"description":"Dimension to split the data into one series per value, for example country, store or attribution_channel.","title":"Segmentation"}},"required":["date_from","date_to"],"title":"get_funnel_dataArguments","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_ltv_data":{"post":{"operationId":"get_ltv_data","summary":"Get actual (not predicted) lifetime value per subscriber for revenue, proceeds and net revenue, by period. Use for \"What","description":"Get actual (not predicted) lifetime value per subscriber for revenue, proceeds and net revenue, by period. Use for \"What is the lifetime value of my Adapty subscribers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date_from":{"description":"First day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date From","type":"string"},"date_to":{"description":"Last day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date To","type":"string"},"period_unit":{"anyOf":[{"enum":["day","week","month","quarter","year"],"type":"string"},{"type":"null"}],"default":null,"description":"Time bucket: day, week, month, quarter or year.","title":"Period Unit"},"period_type":{"anyOf":[{"enum":["renewals","days"],"type":"string"},{"type":"null"}],"default":null,"description":"Columns by renewals or by days.","title":"Period Type"},"segmentation":{"anyOf":[{"enum":["period","renewal_status","cancellation_reason","store_product_id","country","store","paywall_id","audience_id","placement_id","flow_id","flow_screen_id","segment_id","duration","offer_category","offer_type","offer_id","attribution_source","attribution_status","attribution_channel","attribution_campaign","attribution_adgroup","attribution_adset","attribution_creative","day","week","month","year"],"type":"string"},{"type":"null"}],"default":null,"description":"Dimension to split the data into one series per value, for example country, store or attribution_channel.","title":"Segmentation"}},"required":["date_from","date_to"],"title":"get_ltv_dataArguments","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_retention_data":{"post":{"operationId":"get_retention_data","summary":"Get subscription retention: how many users stay subscribed step by step, absolute and relative. Use for \"How well does m","description":"Get subscription retention: how many users stay subscribed step by step, absolute and relative. Use for \"How well does my Adapty app retain subscribers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date_from":{"description":"First day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date From","type":"string"},"date_to":{"description":"Last day of the period as YYYY-MM-DD.","maxLength":200,"title":"Date To","type":"string"},"use_trial":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to count users who started with a trial.","title":"Use Trial"},"segmentation":{"anyOf":[{"enum":["period","renewal_status","cancellation_reason","store_product_id","country","store","paywall_id","audience_id","placement_id","flow_id","flow_screen_id","segment_id","duration","offer_category","offer_type","offer_id","attribution_source","attribution_status","attribution_channel","attribution_campaign","attribution_adgroup","attribution_adset","attribution_creative","day","week","month","year"],"type":"string"},{"type":"null"}],"default":null,"description":"Dimension to split the data into one series per value, for example country, store or attribution_channel.","title":"Segmentation"}},"required":["date_from","date_to"],"title":"get_retention_dataArguments","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_placements":{"post":{"operationId":"list_placements","summary":"List paywall, onboarding or flow placements with their audiences, segments, A/B tests and the paywall each audience gets","description":"List paywall, onboarding or flow placements with their audiences, segments, A/B tests and the paywall each audience gets. Use for \"Which paywall does each audience see in my Adapty placements\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"placement_type":{"description":"Which placements to return: paywall, onboarding or flow.","enum":["paywall","onboarding","flow"],"title":"Placement Type","type":"string"}},"required":["placement_type"],"title":"list_placementsArguments","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}}}}