What is an API?

API stands for Application Programming Interface. Think of it as a bridge that allows different software applications to communicate with each other programmatically.

Why Use the Alterna CX API?

With our API, you can automate the process of importing customer feedback data into Alterna CX and exporting analyzed data to your own systems. This eliminates manual work and enables seamless integration with your existing workflows.

Common Use Cases

Import Data

Automatically send customer feedback from your own systems, apps, or surveys into Alterna CX for AI-powered analysis.

Export Data

Pull analyzed feedback data, sentiment scores, and insights from Alterna CX into your data warehouse, BI tools, or custom dashboards.

How to Get Your API Key

Your API key is a unique identifier that authenticates your requests to the Alterna CX API. You'll need to include this key in every API request you make.

1

Login to your Alterna CX account at https://revelio.alternacx.com/

2

Navigate to your profile settings and click on the "API Access" tab.

3

Your API key will be displayed in the "AlternaCX API" section. Click the "Copy API KEY" button to copy it to your clipboard.

4

If you need to reset your API key for security reasons, click the refresh icon next to the "Copy API KEY" button to generate a new key.

Keep Your API Key Safe

Treat your API key like a password. Never share it publicly or commit it to version control. If you suspect your key has been compromised, reset it immediately using the refresh button.

API Key location in Alterna CX dashboard

Upload Data (Import API)

Use the Upload Data API endpoint to programmatically import customer feedback data into Alterna CX. This allows you to send survey responses, reviews, or any customer feedback from your systems directly to Alterna CX for AI-powered analysis.

Method: POST
Endpoint: https://revelio-externaldata-api.alternacx.com/api/import-data

Authentication

This request uses Bearer Token authentication. Include your API key in the Authorization header.

Headers

Header Value
Accept application/json
Content-Type application/json
Authorization Bearer {token}

Request Sample

[
    {
        "InviteeId": "S324324",
        "FullName": "John Doe",
        "CustomData": [
            "custom segment"
        ],
        "AnswerDate": "2023-11-07T16:16",
        "Text": "Sample text"
    },
    {
        "InviteeId": "S2323",
        "FullName": "Sue Davids",
        "CustomData": [
            "custom segment 2"
        ],
        "AnswerDate": "2023-11-07T16:16",
        "Text": "Sample Text"
    }
]

Request Parameters

InviteeId string required

Unique identifier for the survey invitation or feedback entry.

FullName string required

Full name of the customer providing the feedback.

CustomData array optional

Array of custom segments or tags to categorize the feedback (e.g., customer type, location, product line).

AnswerDate datetime required

Date and time when the feedback was provided, in ISO 8601 format (YYYY-MM-DDTHH:MM).

Text string required

The actual feedback text or comment from the customer.

Export Data API

Use the Export Data API endpoint to retrieve analyzed customer feedback data from Alterna CX. This allows you to pull sentiment scores, topics, and feedback data into your own systems for further analysis or reporting.

Method: POST
Endpoint: https://revelio-exportdata-api.alternacx.com/api/export-data

Authentication

This request uses Bearer Token authentication. Include your API key in the Authorization header.

Headers

Header Value
Accept application/json
Content-Type application/json
Authorization Bearer {token}

Request Information

You can send a maximum of 10 requests per second. If you exceed this limit, your requests will wait in the queue and are processed in order. The queue size is 5. If you exceed the queue size, you will receive a 429 status code.

Property Information

fromDate datetime required

The start date of the data you want to export. Use ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

toDate datetime required

The end date of the data you want to export. Use ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

sources array required

The sources of the data you want to export. Available sources: Api, File, App Store, Google, Google Playstore, Trustpilot, Consumer Affairs, DoorDash, Uber Eats, Yelp.

searchAfter string optional

The searchAfter field from the last record you received. Used for pagination to get the next page of results.

Request Sample

{
    "fromDate": "2023-11-07T16:16",
    "toDate": "2023-11-07T16:16",
    "sources": [
        "File",
        "Api"
    ],
    "searchAfter": [
        "1714694400000",
        "1714694400123"
    ]
}

Explanation

If your response contains a searchAfter field, you can use it to get the next page of data. Send the searchAfter value as a query parameter in your next request. If the searchAfter field is not present in the response, it means this is the last page and you don't need to use this parameter in the first request.

Response Information

Per request, you can retrieve a maximum of 100 records. If you have more records, use the searchAfter field to get the next page of data.

Response Sample

{
  "totalCount": 1,
  "data": [
    {
      "sentimentScore": 4,
      "sentiment": "Positive",
      "topics": [
        2829,
        2830,
        2831
      ],
      "reviewText": "Great service and friendly staff!",
      "reviewDate": "2023-11-07T16:16",
      "source": "Google",
      "location": "New York Store",
      "customData": ["VIP Customer"],
      "fullName": "John Doe"
    }
  ]
}

Response Fields

totalCount integer

Total number of records in the current response.

sentimentScore integer

Numerical sentiment score (typically 1-5, where higher is more positive).

sentiment string

Sentiment classification (e.g., "Positive", "Negative", "Neutral").

topics array

Array of topic IDs identified in the feedback by AI analysis.

Other Integrations

Beyond our API, Alterna CX offers pre-built integrations with over 85 review websites and 150 business applications to help you centralize and analyze customer feedback from all your sources.

Explore All Available Integrations

Connect your favorite tools and platforms with Alterna CX to streamline your customer feedback analysis workflow. From review sites like Google, Yelp, and TripAdvisor to business apps like Slack, Salesforce, and HubSpot.

View All Integrations
85+ Review Sites
150+ Apps
API Access
Automation

Review Websites

Connect with popular review platforms including Google Reviews, Yelp, TripAdvisor, Trustpilot, and more to centralize your feedback analysis.

Business Apps

Integrate with CRM systems, helpdesk tools, communication platforms, and more to automate workflows and sync customer data.

Custom API

Build custom integrations with our powerful API to pull and push data between Alterna CX and your existing systems.

Need Help?

If you have any questions about using the API or setting up integrations, our support team is here to help.

[email protected]