Getting Started
Quickstart
Step 1: Sign Up and Get Your API Key
- Sign up for a Roundtable Alias account.
- Log in and navigate to the account dashboard.
- Click ”+ Create new API Key” and copy the API key.
Step 2: Prepare Your Survey Data
To use Roundtable Alias, you’ll need to collect the following data for each survey response:
participant_id
: A unique identifier for the respondentsurvey_id
: A unique identifier for the surveyquestions
: An object mapping question IDs to the text of each questionresponses
: An object mapping question IDs to the respondent’s answersquestion_histories
(optional): Typing data for each question, collected using the JavaScript tracker
Ensure your data is formatted correctly before sending it to the API.
Step 3: Make an API Request
Send a POST request to the Roundtable Alias API with your survey data:
curl -X POST https://api.roundtable.ai/alias/v015 \
-H 'Content-Type: application/json' \
-H 'api_key: YOUR_API_KEY' \
-d '{
"participant_id": "p123",
"survey_id": "s456",
"questions": {
"Q1": "How has our product improved your workflow?"
},
"responses": {
"Q1": "It has made me hungry for pineapple pizza."
},
"question_histories": {
"Q1": [
[
{"s":"I","t":0},
{"s":"It","t":253},
{"s":"It ","t":1290},
{"s":"It h","t":1563},
{"s":"It ha","t":1817},
...
]
]
}
}'
Step 4: Interpret the API Response
The API will respond with a JSON object containing fraud signals and effort scores for each question:
{
"error": false,
"flagged": true,
"num_checks_failed": 1,
"response_groups": {
"Q1": 1
},
"effort_ratings": {
"Q1": 5
},
"checks": {
"Q1": [
"Automated test: Off-topic"
]
},
"model": "alias-v015"
}
Review the flagged
, effort_ratings
, and checks
fields to identify suspicious responses:
flagged
:true
if the response failed any fraud checks,false
otherwiseeffort_ratings
: An object with effort scores (1-10) for each question, where 1 is low effort and 10 is high effortchecks
: An object listing the specific fraud checks failed for each question
Use this data to decide which responses to remove or investigate further.
Next Steps
- Learn more about the JavaScript tracker for enhanced fraud detection.
- Explore the API reference for details on request and response formats.
- Read the FAQ for answers to common questions.
Support
If you have any questions or need assistance, our support team is here to help:
- Email us at support@roundtable.ai.
- Visit the Support Center for guides and troubleshooting tips.
- Check the Status Page for updates on system performance and uptime.