{"openapi":"3.1.0","info":{"title":"CleverTap (BYOK) API","version":"0.1.0","description":"CleverTap (BYOK) lets an AI assistant read your own CleverTap data through the CleverTap API with a key you supply (account passcode). Read-only: 9 tools (list_api_campaigns, get_campaign_report, get_event_count, get_profile_count, get_event_trend, get_top_event_property_values, get_live_active_users, list_catalogs, list_content_blocks). The BYOK key travels with each request, is used for that...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-clevertap.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-clevertap/docs"},"termsOfService":"https://connectorbay.com/byok-clevertap/terms"},"servers":[{"url":"https://byok-clevertap.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-clevertap/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/list_api_campaigns":{"post":{"operationId":"list_api_campaigns","summary":"List campaigns created through the CleverTap API whose scheduled start falls in a date range, with id, name, schedule ti","description":"List campaigns created through the CleverTap API whose scheduled start falls in a date range, with id, name, schedule time and status. Use for \"Which API campaigns did CleverTap schedule in September 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"date_from":{"description":"First day to include, as an integer YYYYMMDD, for example 20260901.","maximum":20991231,"minimum":20100101,"title":"Date From","type":"integer"},"date_to":{"description":"Last day to include (inclusive), as an integer YYYYMMDD, not before date_from.","maximum":20991231,"minimum":20100101,"title":"Date To","type":"integer"}},"required":["region","date_from","date_to"],"title":"list_api_campaignsArguments","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_campaign_report":{"post":{"operationId":"get_campaign_report","summary":"Get the report of one finished campaign by its numeric id (see list_api_campaigns): messages sent and clicked. Use for \"","description":"Get the report of one finished campaign by its numeric id (see list_api_campaigns): messages sent and clicked. Use for \"How many messages did CleverTap campaign 1457432766 send and how many were clicked\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"campaign_id":{"description":"Numeric CleverTap campaign id.","minimum":1,"title":"Campaign Id","type":"integer"}},"required":["region","campaign_id"],"title":"get_campaign_reportArguments","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_event_count":{"post":{"operationId":"get_event_count","summary":"Count how many times an event happened in a date range. The status can be partial while the result is still being comput","description":"Count how many times an event happened in a date range. The status can be partial while the result is still being computed; ask again shortly. Use for \"How many Charged events happened in CleverTap last month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"event_name":{"description":"Event name, standard (for example 'Charged', 'App Launched') or custom. Letters, digits, underscores and hyphens, up to 255 characters.","maxLength":255,"title":"Event Name","type":"string"},"date_from":{"description":"First day to include, as an integer YYYYMMDD, for example 20260901.","maximum":20991231,"minimum":20100101,"title":"Date From","type":"integer"},"date_to":{"description":"Last day to include (inclusive), as an integer YYYYMMDD, not before date_from.","maximum":20991231,"minimum":20100101,"title":"Date To","type":"integer"}},"required":["region","event_name","date_from","date_to"],"title":"get_event_countArguments","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_profile_count":{"post":{"operationId":"get_profile_count","summary":"Count the user profiles that performed an event in a date range. The status can be partial while the result is still bei","description":"Count the user profiles that performed an event in a date range. The status can be partial while the result is still being computed; ask again shortly. Use for \"How many users did a Charged event in CleverTap in September\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"event_name":{"description":"Event name, standard (for example 'Charged', 'App Launched') or custom. Letters, digits, underscores and hyphens, up to 255 characters.","maxLength":255,"title":"Event Name","type":"string"},"date_from":{"description":"First day to include, as an integer YYYYMMDD, for example 20260901.","maximum":20991231,"minimum":20100101,"title":"Date From","type":"integer"},"date_to":{"description":"Last day to include (inclusive), as an integer YYYYMMDD, not before date_from.","maximum":20991231,"minimum":20100101,"title":"Date To","type":"integer"}},"required":["region","event_name","date_from","date_to"],"title":"get_profile_countArguments","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_event_trend":{"post":{"operationId":"get_event_trend","summary":"Get an event's counts per day, ISO week or month over a range of up to one year, as event totals or distinct users. The ","description":"Get an event's counts per day, ISO week or month over a range of up to one year, as event totals or distinct users. The status can be partial while the result is still being computed; ask again shortly. Use for \"Show the daily number of Charged events in CleverTap for September 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"event_name":{"description":"Event name, standard (for example 'Charged', 'App Launched') or custom. Letters, digits, underscores and hyphens, up to 255 characters.","maxLength":255,"title":"Event Name","type":"string"},"date_from":{"description":"First day to include, as an integer YYYYMMDD, for example 20260901.","maximum":20991231,"minimum":20100101,"title":"Date From","type":"integer"},"date_to":{"description":"Last day to include (inclusive), as an integer YYYYMMDD, not before date_from.","maximum":20991231,"minimum":20100101,"title":"Date To","type":"integer"},"trend_type":{"description":"Granularity: daily, weekly or monthly.","enum":["daily","weekly","monthly"],"title":"Trend Type","type":"string"},"unique":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to count distinct users instead of total occurrences.","title":"Unique"}},"required":["region","event_name","date_from","date_to","trend_type"],"title":"get_event_trendArguments","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_event_property_values":{"post":{"operationId":"get_top_event_property_values","summary":"Get the most (or least) frequent values of one event property over a date range, with their counts. The status can be pa","description":"Get the most (or least) frequent values of one event property over a date range, with their counts. The status can be partial while the result is still being computed; ask again shortly. Use for \"What are the most common Amount values on Charged events in CleverTap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"event_name":{"description":"Event name, standard (for example 'Charged', 'App Launched') or custom. Letters, digits, underscores and hyphens, up to 255 characters.","maxLength":255,"title":"Event Name","type":"string"},"date_from":{"description":"First day to include, as an integer YYYYMMDD, for example 20260901.","maximum":20991231,"minimum":20100101,"title":"Date From","type":"integer"},"date_to":{"description":"Last day to include (inclusive), as an integer YYYYMMDD, not before date_from.","maximum":20991231,"minimum":20100101,"title":"Date To","type":"integer"},"property_name":{"description":"Name of the event property to break down, for example 'Amount'.","maxLength":255,"title":"Property Name","type":"string"},"top_n":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many top values to return (1 to 100).","title":"Top N"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"desc for the most frequent values, asc for the least frequent.","title":"Order"}},"required":["region","event_name","date_from","date_to","property_name"],"title":"get_top_event_property_valuesArguments","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_live_active_users":{"post":{"operationId":"get_live_active_users","summary":"Get the number of users active in the last five minutes, optionally split by new vs returning, session source, browser, ","description":"Get the number of users active in the last five minutes, optionally split by new vs returning, session source, browser, OS and device. Use for \"How many users are active in my CleverTap app right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"user_type":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to split by new and returning users.","title":"User Type"},"session_source":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to split by session source.","title":"Session Source"},"browser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to split by browser.","title":"Browser"},"os":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to split by operating system.","title":"Os"},"device":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to split by device type.","title":"Device"}},"required":["region"],"title":"get_live_active_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_catalogs":{"post":{"operationId":"list_catalogs","summary":"List product catalogs with name, description, product count, status and creation time, 100 per page at most. Use for \"Wh","description":"List product catalogs with name, description, product count, status and creation time, 100 per page at most. Use for \"What catalogs exist in my CleverTap account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"status":{"anyOf":[{"enum":["ACTIVE","INACTIVE","DELETED"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by status.","title":"Status"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Partial match on the catalog name.","title":"Search"},"page":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Catalogs per page (1 to 100).","title":"Size"}},"required":["region"],"title":"list_catalogsArguments","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_content_blocks":{"post":{"operationId":"list_content_blocks","summary":"List content blocks (reusable message snippets) with id, name, type, author and dates. The snippet text itself is not re","description":"List content blocks (reusable message snippets) with id, name, type, author and dates. The snippet text itself is not returned. Use for \"Which content blocks exist in CleverTap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your CleverTap region code: in1 (India), sg1 (Singapore), us1 (United States), aps3 (Indonesia) or mec1 (Middle East). The default Europe region (api.clevertap.com) is not supported.","enum":["in1","sg1","us1","aps3","mec1"],"title":"Region","type":"string"},"updated_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only blocks updated at or after this ISO 8601 time, for example 2026-01-01T00:00:00.000Z.","title":"Updated From"},"updated_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only blocks updated at or before this ISO 8601 time.","title":"Updated To"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Blocks per page (1 to 100).","title":"Page Size"}},"required":["region"],"title":"list_content_blocksArguments","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}}}}