HomeGuidesAPI Reference
Discussions

Insights API Overview

ClearSlide APIs

Suggest Edits

What is the ClearSlide Insights API?

The Insights API allows you to retrieve customer engagement data for ClearSlide links, emails, and meetings programmatically.

🚧

Prerequisites

When you complete Prerequisites in ClearSlide APIs section, you will have an Authorization Token to test against our API.

How to generate complete Insights API request code?

You can generate a complete functional request code snippet for the tech stack of your choice.

You can interactively add Headers and Query parameters (including filters and sorting) into the form. The documentation tool updates API request code accordingly.

Developers can copy and paste the auto-generated API request code into your project.

How do I test the Insights API request code?

Here are a few options:

  • Try it out allows you to trigger a request and view JSON results immediately
  • Copy the request code snippet into your project. Trigger the request and parse the response to view the results in a JSON format. Coming soon...

Sample Request Code

Our reference documentation auto-generates request code for Curl, Node, Ruby, Javascript, Python.

curl --request GET \
  --url 'https://platform.clearslide.com/v2/insights?filter%5Binsights%5D%5BactivityDate%5D=2017-02-28T14%3A12%3A29-08%3A00' \
  --header 'authorization: Bearer a61766c5-3e55-42f8-ae97-9239105f5391' \
  --header 'targetuserid: E36J6TFX7HF2GPJNSDT8'

Sample JSON Response

[
  {
    "type": "string",
    "id": "string",
    "attributes": {
      "numClicks": 0,
      "lastViewed": "string",
      "prospectName": "string",
      "internal": true,
      "totalViewTimeSec": 0,
      "companyName": "string",
      "companyCrmID": "string",
      "personCrmID": "string",
      "thirdPartyClientID": "string",
      "thirdPartyExternalID": "string",
      "numLeads": 0,
      "activityDate": "2017-07-31T23:30:54.550Z",
      "source": "string",
      "hasLeadForm": true,
      "type": "EMAIL",
      "vid": "string",
      "numEmailOpened": 0,
      "lastViewer": {
        "name": "string",
        "location": "string",
        "viewing": true,
        "durationSeconds": 0,
        "numSlides": 0
      },
      "embeddedPitchVids": [
        "string"
      ],
      "decks": {
        "deckID": 0,
        "vid": "string",
        "name": "string",
        "numSlides": 0
      },
      "style": "string",
      "numViewers": 0,
      "slideCount": 0,
      "analyticsId": "string",
      "createDate": "string",
      "subject": "string",
      "emailRecipients": {
        "email": "string",
        "formattedName": "string",
        "emailStatus": "string",
        "displayName": 0,
        "latestActivityTimestamp": 0
      },
      "uploadMethod": "string",
      "minutes": 0,
      "avgEngagementActivity": 0,
      "hostedBy": "string",
      "attendees": {
        "name": "string",
        "inPerson": true,
        "manualEntry": true
      },
      "engagmentDataPoints": {
        "timestamp": "string",
        "value": 0
      },
      "presenterVID": "string",
      "recordingCount": 0,
      "hasRecording": true,
      "recordings": [
        {
          "id": "string",
          "videos": [
            {
              "url": "string",
              "urlExpiresAt": "2017-07-31T23:30:54.550Z",
              "height": 0,
              "width": 0,
              "format": "string"
            }
          ]
        }
      ],
      "meetingType": "string",
      "seconds": "string",
      "totalViewers": "string",
      "startDate": "string"
    }
  }
]

Updated almost 4 years ago