Viable API Ingest documentation

About Viable
Viable API Ingest documentation

Below are instructions for how to import custom data into Viable.


Getting your API key

  1. In Viable, click on "Admin" -> "Integrations"
  2. Scroll down the page
  3. Copy your API key


POSTing data to the ingress endpoint

The https://app.askviable.com/api/[YourViableAPIKey]/ingress endpoint allows you to POST custom data into Viable. It accepts a JSON body with these attributes:

  • text (required) The text you'd like us to ingest, e.g "The Viable API documentation could be improved by..."
  • text_created_at (required) The timestamp for the date and time the text was created, e.g. "2021-04-20T16:20:00+00:00"
  • email (required) The email (or other unique identifier) of the author of the text, e.g. "test@example.com"
  • source (optional) The source of the text, e.g. "feedback-form"
  • prompt (optional) The question or request that prompted this text, e.g. "Do you have any feedback for us?"
  • traits (optional) an object containing traits for the user, e.g. {"Subscription": "Enterprise", "User Type": "Driver"}
  • metadata (optional) an object containing metadata for the feedback, e.g. {"App Version": "2.3.0", "Product": "iOS App"}
{
 "text": "Some text to ingest",
 "text_created_at": "2021-04-20T16:20:00+00:00",
 "email": "test@example.com",
 "metadata": {
 "Label One": "Value",
 "Label Two": "Next Value"
 },
 "traits": {
 "Trait Label One": "Trait Value",
 "Trait Label Two": "Next Trait Value"
 }
}
Viable API Ingest documentation
Viable Team
June 11, 2021
Daniel Erickson
October 19, 2023
Discover the seamless integration process of combining Salesforce Service Cloud's capabilities with Viable's AI analytics prowess.
READ MORE
Viable Team
February 4, 2022
Understand what your customers are telling you without sacrificing speed, completeness, or accuracy with feedback reports from Viable...
READ MORE
Viable Team
March 8, 2021
You can analyze Pendo feedback or comments by connecting Pendo to Viable in Zapier. Use our Pendo Feedback Zapier templates for new…
READ MORE

Get your first report free

Book a demo to get immediate insights from your customer feedback.

Viable API Ingest documentation

Viable API Ingest documentation

Below are instructions for how to import custom data into Viable.


Getting your API key

  1. In Viable, click on "Admin" -> "Integrations"
  2. Scroll down the page
  3. Copy your API key


POSTing data to the ingress endpoint

The https://app.askviable.com/api/[YourViableAPIKey]/ingress endpoint allows you to POST custom data into Viable. It accepts a JSON body with these attributes:

  • text (required) The text you'd like us to ingest, e.g "The Viable API documentation could be improved by..."
  • text_created_at (required) The timestamp for the date and time the text was created, e.g. "2021-04-20T16:20:00+00:00"
  • email (required) The email (or other unique identifier) of the author of the text, e.g. "test@example.com"
  • source (optional) The source of the text, e.g. "feedback-form"
  • prompt (optional) The question or request that prompted this text, e.g. "Do you have any feedback for us?"
  • traits (optional) an object containing traits for the user, e.g. {"Subscription": "Enterprise", "User Type": "Driver"}
  • metadata (optional) an object containing metadata for the feedback, e.g. {"App Version": "2.3.0", "Product": "iOS App"}
{
 "text": "Some text to ingest",
 "text_created_at": "2021-04-20T16:20:00+00:00",
 "email": "test@example.com",
 "metadata": {
 "Label One": "Value",
 "Label Two": "Next Value"
 },
 "traits": {
 "Trait Label One": "Trait Value",
 "Trait Label Two": "Next Trait Value"
 }
}
Viable API Ingest documentation
Viable Team, June 11, 2021