CrossEngage

CrossEngage Kpi API

The Kpi API from CrossEngage — 2 operation(s) for kpi.

GitHub OpenAPI

Operations 2

GET /kpi Get all KPIs #
GET /kpi/{id} Get a certain KPI #

Documentation

📖
APIReference
https://usermanagementv2.docs.apiary.io/
📖
Documentation
https://api.documentation.crossengage.io/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/authentication/crossenagage-authentication.yml
📖
APIReference
https://usermanagementv1.docs.apiary.io/
📖
APIReference
https://productfeedapiv1.docs.apiary.io/
📖
APIReference
https://userseventsexportapiv1.docs.apiary.io/
📖
APIReference
https://statisticsapi1.docs.apiary.io/
📖
APIReference
https://fileattachmentsv1.docs.apiary.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/openapi/crossenagage-kpi-api-openapi.yml

Other Resources

🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-user-management-v2.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-user-management-v1.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-raw-export-v1.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-statistics-v1.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-file-attachments-v1.apib

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/crossenagage-kpi-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

crossenagage-kpi-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Statistics Kpi API
  version: ''
  description: The Statistics API is designed to help you synchronously access all story, campaign & message statistics performance data available in CrossEngage.
servers:
- url: https://api.crossengage.io/statistics
tags:
- name: Kpi
paths:
  /kpi:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items: {}
              example:
              - id: '213'
                name: Conversion to View Rate
                formula: CONVERSION / UNIQUE VIEWED * 100
                type: PERCENTAGE
                createdAt: 2015-08-05T08:40Z
                updatedAt: 2015-08-05T08:40Z
      summary: Get all KPIs
      operationId: Get all KPIs
      description: Use this endpoint to get all of the KPIs available on your account and their details.
      tags:
      - Kpi
      parameters:
      - name: X-XNG-ApiVersion
        in: header
        description: e.g. 2
        required: false
        x-example: '2'
        schema:
          type: string
      - name: X-XNG-AuthToken
        in: header
        description: e.g. YourAPIKey
        required: false
        x-example: YourAPIKey
        schema:
          type: string
  /kpi/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                    enum:
                    - Sent
                    - Delivered
                    - Viewed
                    - Unique Viewed
                    - Clicked
                    - Unique Clicked
                    - Soft Bounced
                    - Hard Bounced
                    - Bounced
                    - Unsubscribed
                    - Marked as Spam
                    - Conversion
                    - Delivery Rate
                    - View to Delivery Rate
                    - Click to Delivery Rate
                    - Click-through-Rate (CTR)
                    - Bounce Rate
                    - Spam Rate
                    - Unsubscribe Rate
                    - Conversion to Delivery Rate
                    - Conversion to View Rate
                    - Conversion to Click Rate
                    - Not Sent due to Control Group
                    - Control Group Conversion
                    - Control Group Conversion Rate
                  formula:
                    type: string
                    enum:
                    - SENT
                    - DELIVERED
                    - VIEWED
                    - UNIQUE VIEWED
                    - CLICKED
                    - UNIQUE CLICKED
                    - SOFT BOUNCED
                    - HARD BOUNCED
                    - SOFT BOUNCED + HARD BOUNCED
                    - UNSUBSCRIBED
                    - MARKED AS SPAM
                    - CONVERSION
                    - DELIVERED / SENT * 100
                    - UNIQUE VIEWED / DELIVERED * 100
                    - UNIQUE CLICKED / DELIVERED * 100
                    - UNIQUE CLICKED / UNIQUE VIEWED * 100
                    - (SOFT BOUNCED + HARD BOUNCED) / (SOFT BOUNCED + HARD BOUNCED + DELIVERED) * 100
                    - MARKED AS SPAM / DELIVERED * 100
                    - UNSUBSCRIBED / DELIVERED * 100
                    - CONVERSION / DELIVERED * 100
                    - CONVERSION / UNIQUE VIEWED * 100
                    - CONVERSION / UNIQUE VIEWED * 100
                    - SENT_CONTROL_GROUP
                    - GOAL_COMPLETED_CONTROL_GROUP
                    - GOAL_COMPLETED_CONTROL_GROUP / SENT_CONTROL_GROUP * 100
                  type:
                    type: string
                    enum:
                    - INTEGER
                    - PERCENTAGE
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
              example:
                id: '213'
                name: Conversion to View Rate
                formula: CONVERSION / UNIQUE VIEWED * 100
                type: PERCENTAGE
                createdAt: 2015-08-05T08:40Z
                updatedAt: 2015-08-05T08:40Z
      summary: Get a certain KPI
      operationId: Get a certain KPI
      description: Use this endpoint to get the details of a certain KPI by ID.
      tags:
      - Kpi
      parameters:
      - name: id
        in: path
        description: '`id` of a KPI'
        required: true
        x-example: '234'
        schema:
          type: string
      - name: X-XNG-ApiVersion
        in: header
        description: e.g. 2
        required: false
        x-example: '2'
        schema:
          type: string
      - name: X-XNG-AuthToken
        in: header
        description: e.g. YourAPIKey
        required: false
        x-example: YourAPIKey
        schema:
          type: string