Developer Documentation

Everything you need to integrate ROAST into your workflow

CSV Format

Required Columns

text - Review text and rating
rating - Review text and rating

Optional Columns

date - Additional metadata
user_id - Additional metadata
platform - Additional metadata

Example CSV

text,rating,date
"Great app! Love the features",5,2024-01-15
"Crashes on startup",1,2024-01-14
"Good but needs improvement",3,2024-01-13

Getting Started

Quick Start

Get up and running in 5 minutes

// Install the SDK
npm install @roast/sdk

// Initialize
import { RoastClient } from '@roast/sdk';

const client = new RoastClient({
  apiKey: process.env.ROAST_API_KEY
});

// Upload reviews
const result = await client.reviews.upload({
  file: reviewsFile,
  platform: 'google_play'
});

Authentication

API Keys

All API requests require authentication via API key

curl -X POST https://api.roast.dev/v1/reviews \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reviews": [...]}'

CSV Upload API

Upload Reviews

POST endpoint to upload and analyze review data

POST /api/bulk/upload

Headers:
  Authorization: Bearer YOUR_API_KEY
  Content-Type: multipart/form-data

Body:
  file: CSV file with reviews
  
Response:
  {
    "upload_id": "uuid",
    "status": "processing",
    "total_reviews": 1500,
    "estimated_time": "2-3 minutes"
  }

Get Upload Status

Check processing status of uploaded reviews

GET /api/bulk/upload/{upload_id}

Response:
  {
    "upload_id": "uuid",
    "status": "completed",
    "total_reviews": 1500,
    "clusters_created": 23,
    "noise_filtered": 142
  }

Clusters API

List Clusters

Get all clusters for an upload

GET /api/bulk/clusters/{upload_id}

Response:
  {
    "clusters": [
      {
        "cluster_id": 1,
        "label": "App Crashes on Launch",
        "summary": "Multiple users reporting...",
        "severity": "critical",
        "review_count": 45,
        "avg_rating": 1.8
      }
    ]
  }

Get Cluster Details

Retrieve full details for a specific cluster

GET /api/bulk/clusters/{upload_id}/{cluster_id}

Response:
  {
    "cluster_id": 1,
    "label": "App Crashes on Launch",
    "summary": "Users report the app crashes...",
    "severity": "critical",
    "reviews": [
      {
        "text": "App crashes every time...",
        "rating": 1,
        "date": "2024-01-15"
      }
    ]
  }

Need Help?

Our support team is here to help you integrate ROAST

Contact Support

CSV Format

Required Columns

text - Review text and rating
rating - Review text and rating

Optional Columns

date - Additional metadata
user_id - Additional metadata
platform - Additional metadata

Example CSV

text,rating,date
"Great app! Love the features",5,2024-01-15
"Crashes on startup",1,2024-01-14
"Good but needs improvement",3,2024-01-13

// Install the SDK npm install @roast/sdk // Initialize import { RoastClient } from '@roast/sdk'; const client = new RoastClient({ apiKey: process.env.ROAST_API_KEY }); // Upload reviews const result = await client.reviews.upload({ file: reviewsFile, platform: 'google_play' });

POST /api/bulk/upload Headers: Authorization: Bearer YOUR_API_KEY Content-Type: multipart/form-data Body: file: CSV file with reviews Response: { "upload_id": "uuid", "status": "processing", "total_reviews": 1500, "estimated_time": "2-3 minutes" }

GET /api/bulk/clusters/{upload_id} Response: { "clusters": [ { "cluster_id": 1, "label": "App Crashes on Launch", "summary": "Multiple users reporting...", "severity": "critical", "review_count": 45, "avg_rating": 1.8 } ] }

GET /api/bulk/clusters/{upload_id}/{cluster_id} Response: { "cluster_id": 1, "label": "App Crashes on Launch", "summary": "Users report the app crashes...", "severity": "critical", "reviews": [ { "text": "App crashes every time...", "rating": 1, "date": "2024-01-15" } ] }