API Overview

API Overview

Spartera provides an Analytics as a Service platform for securely
sharing, monetizing, and consuming analytics while ensuring data never
leaves your infrastructure. The API supports data providers (sellers)
and analytics consumers (buyers) by orchestrating insights,
transactions, and marketplace operations through a RESTful API.

Primary Use Cases

Data Providers (Sellers)

• Expose Analytics as APIs: Convert data assets into monetizable
  API endpoints without exposing raw data
• Secure Monetization: Generate revenue from analytics while
  maintaining complete data privacy
• Usage Management: Track consumption, manage access, and optimize
  pricing strategies

Analytics Consumers (Buyers)

• Access Premium Analytics: Consume high-quality analytics from
  verified providers
• Seamless Integration: Simple REST API integration into existing
  applications
• Transparent Pricing: Clear usage-based pricing with no hidden
  costs

Core Benefits

Data Privacy First

• Data Never Leaves Infrastructure: Analytics are processed
  in-place at the source
• Zero Data Transfer: Only analytical results are shared, never
  raw data
• Regulatory Compliance: Perfect for GDPR, HIPAA, and other
  privacy-sensitive applications

Secure Architecture

• API Key Authentication: Secure access control for all endpoints
• Role-Based Permissions: Granular access control for different
  user types
• Audit Logging: Comprehensive tracking of all API usage and
  transactions

Base Configuration

Base URL

HTTP

https://api.spartera.com

API Version

HTTP

v1.0

Complete Endpoint Format

HTTP

https://api.spartera.com/{endpoint_path}

Supported Protocols

• HTTPS Only: All communication encrypted in transit
• TLS 1.2+: Modern encryption standards required
• Certificate Validation: Proper SSL certificate validation
  required

Request Format

Content Type

All requests and responses use JSON format:

JSON

Content-Type: application/json
Accept: application/json

Authentication Header

All API requests require authentication:

JSON

x-api-key: {your_api_key}

Standard Headers

JSON

accept: application/json
content-type: application/json
x-api-key: {your_api_key}

Response Format

Standard JSON Structure

All responses follow consistent JSON structure:

JSON

{
  "data": {},
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "version": "1.0"
  }
}

Success Responses

• 200 OK: Successful GET, PATCH requests
• 201 Created: Successful POST requests
• 204 No Content: Successful DELETE requests

Error Responses

All errors include structured error information:

JSON

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request parameters are invalid",
    "details": {}
  }
}

API Capabilities

Analytics Orchestration

• In-Place Processing: Analytics executed at data source location
• Result Aggregation: Processed results returned via API
• Performance Optimization: Caching and optimization for fast
  response times

Marketplace Operations

• Analytics Discovery: Browse and search available analytics
• Pricing Management: Dynamic pricing and usage-based billing
• Transaction Processing: Secure payment and access management

Data Source Integration

• Multiple Warehouses: BigQuery, Snowflake, Redshift, and more
• Secure Connections: Read-only, encrypted connections to data
  sources
• Connection Management: API endpoints for managing data source
  connections

Development Workflow

For Analytics Providers

1. Connect Data Source: Secure connection to your data warehouse
2. Build Analytics: Create analytical endpoints using UI or SDK
3. Set Pricing: Configure usage-based pricing models
4. Deploy to Marketplace: Publish analytics for consumption
5. Monitor Usage: Track consumption and revenue through API

For Analytics Consumers

1. Discover Analytics: Browse marketplace for relevant analytics
2. Purchase Access: Secure payment and access credential generation
3. Integrate APIs: Simple REST API integration
4. Monitor Usage: Track consumption and manage costs

Security Model

Authentication

• API Key Required: All endpoints require valid API key
• Key Rotation: Support for programmatic key rotation
• Scope Control: Keys can be scoped to specific operations

Authorization

• Role-Based Access: Different permissions for different user types
• Resource-Level Control: Granular permissions for specific
  resources
• Company Isolation: Complete isolation between different companies

Data Protection

• Encryption in Transit: All data encrypted during transmission
• No Data Storage: Platform never stores customer data
• Audit Trails: Comprehensive logging of all access and operations

Rate Limits and Quotas

Default Limits

• Authentication Endpoints: 1000 requests/hour
• Analytics Endpoints: Based on subscription tier
• Marketplace Endpoints: 10000 requests/hour

Quota Management

• Usage Tracking: Real-time tracking of API usage
• Limit Notifications: Alerts when approaching limits
• Upgrade Options: Easy scaling for higher usage needs

Getting Started

Prerequisites

• Spartera Account: Valid account with API access enabled
• Data Source: Connected data warehouse or database
• API Key: Generated from the Spartera dashboard

Quick Start Guide

1. Obtain API Key: Generate key from dashboard settings
2. Test Connection: Use authentication endpoints to verify access
3. Explore Marketplace: Browse available analytics using marketplace
   endpoints
4. Make First Request: Start with simple analytics consumption

SDK and Tools

• REST Clients: Works with any HTTP client library
• SDK Support: Official SDKs for Python, JavaScript, and more
• Postman Collection: Pre-built collection for testing
• OpenAPI Specification: Full API specification for code generation

The Spartera API enables powerful analytics sharing while maintaining
the highest standards of data privacy and security. Whether you're
monetizing your data assets or consuming premium analytics, the API
provides the tools needed for successful analytics as a service.