CleverTap website screenshot

CleverTap

CleverTap is a customer engagement and retention platform that helps businesses understand user behavior, segment audiences, and deliver personalized experiences across mobile push, email, SMS, in-app, web push, and WhatsApp channels. CleverTap exposes a comprehensive REST API surface covering profiles, events, campaigns, real-time analytics, catalogs, feature flags, and more, authenticated via account ID and passcode headers.

8 APIs 0 Features
AudiencesCustomer EngagementCustomer RetentionMarketing AutomationMobile EngagementPush NotificationsUser Behavior

APIs

CleverTap Profile API

Upload, retrieve, update, and delete user profiles in CleverTap with identity, demographic, and custom property data.

CleverTap Event API

Record user events with arbitrary properties for behavioral segmentation, funnels, and triggered messaging.

CleverTap Campaign API

Programmatically create and manage push, email, SMS, web, and in-app campaigns and retrieve message status reports.

CleverTap Bulletins API

Raise a Bulletin in CleverTap when a business event is triggered, used to drive real-time campaign delivery from external systems.

CleverTap Catalog API

Manage product catalog data feeding personalization, recommendations, and product-aware messaging.

CleverTap Custom List API

Create and update custom lists used as audience segments in campaigns and journeys.

CleverTap Remote Config API

Manage feature flags and remote configuration variables delivered to mobile apps and websites.

CleverTap Real-Time Counts API

Query real-time counts and trends of events, profiles, and segments.

Collections

CleverTap REST API

OPEN

Pricing Plans

Clevertap Plans Pricing

3 plans

PLANS

Rate Limits

Clevertap Rate Limits

5 limits

RATE LIMITS

FinOps

Clevertap Finops

FINOPS

Semantic Vocabularies

Clevertap Context

0 classes · 6 properties

JSON-LD

API Governance Rules

CleverTap API Rules

8 rules · 4 errors 4 warnings

SPECTRAL

Resources

👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🌐
DeveloperPortal
DeveloperPortal
🔗
Documentation
Documentation
🔑
Authentication
Authentication
🟢
StatusPage
StatusPage
💰
Pricing
Pricing
📜
PrivacyPolicy
PrivacyPolicy
📜
TermsOfService
TermsOfService
🔗
JSONLD
JSONLD
🔗
Spectral
Spectral
🔗
LlmsText
LlmsText

Sources

apis.yml Raw ↑ 
opencollection: 1.0.0
info:
  name: CleverTap REST API
  version: 1.0.0
request:
  auth:
    type: apikey
    key: X-CleverTap-Account-Id
    value: '{{X-CleverTap-Account-Id}}'
    placement: header
items:
- info:
    name: Profiles
    type: folder
  items:
  - info:
      name: Upload user profiles or events
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/upload
      body:
        type: json
        data: '{}'
    docs: 'Upload an array of records, each typed as "profile" or "event".

      Maximum 1000 records per call.

      '
  - info:
      name: Get a user profile
      type: http
    http:
      method: GET
      url: https://{region}.api.clevertap.com/1/profile.json
      params:
      - name: identity
        value: ''
        type: query
      - name: objectId
        value: ''
        type: query
    docs: Get a user profile
  - info:
      name: Search/query user profiles
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/profiles.json
      body:
        type: json
        data: '{}'
    docs: Search/query user profiles
  - info:
      name: Disassociate (delete) user profiles
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/disassociate
      body:
        type: json
        data: '{}'
    docs: Disassociate (delete) user profiles
- info:
    name: Events
    type: folder
  items:
  - info:
      name: Query events
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/events.json
      body:
        type: json
        data: '{}'
    docs: Query events
- info:
    name: Reports
    type: folder
  items:
  - info:
      name: Get event counts
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/counts/event.json
      body:
        type: json
        data: '{}'
    docs: Get event counts
  - info:
      name: Get profile counts
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/counts/profile.json
      body:
        type: json
        data: '{}'
    docs: Get profile counts
- info:
    name: Campaigns
    type: folder
  items:
  - info:
      name: Create a campaign
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/targets/create.json
      body:
        type: json
        data: '{}'
    docs: 'Create a campaign across push, email, sms, webpush, whatsapp,

      webhook, or notificationinbox channels.

      '
  - info:
      name: Stop a campaign
      type: http
    http:
      method: POST
      url: https://{region}.api.clevertap.com/1/targets/stop.json
      body:
        type: json
        data: '{}'
    docs: Stop a campaign
  - info:
      name: Get campaign result/report
      type: http
    http:
      method: GET
      url: https://{region}.api.clevertap.com/1/targets/result.json
      params:
      - name: req_id
        value: ''
        type: query
    docs: Get campaign result/report
bundled: true