API Playground

Test and explore GoPie's APIs interactively with the API Playground

The API Playground provides an interactive environment to explore and test GoPie's APIs without writing code.

Getting Started

Accessing the Playground

Navigate to the API section in your dashboard
Click on "API Playground"
Select the API endpoint you want to test
Authenticate with your API key

Features

Interactive Documentation

Live API documentation
Request/response examples
Parameter descriptions
Schema validation

Request Builder

Endpoint Selection

Browse all available endpoints
Search by functionality
Filter by API version
View deprecation notices

Parameter Configuration

Visual parameter input
Type validation
Default value suggestions
Required field indicators

Headers Management

Authentication headers
Custom headers
Content-type selection
Accept format options

Request Execution

Testing Requests

One-click execution
Real-time responses
Response time tracking
Status code display

Request History

Recent requests log
Save favorite requests
Re-run with modifications
Export as code

Advanced Features

Code Generation

Language Support

Generate code snippets in:

cURL
Python
JavaScript/Node.js
Java
Go
Ruby
PHP

SDK Examples

Official SDK usage
Authentication setup
Error handling
Best practices

Mock Data

Test Scenarios

Success responses
Error conditions
Edge cases
Performance testing

Data Generation

Realistic test data
Custom schemas
Bulk operations
Randomization

Environment Management

Multiple Environments

Development
Staging
Production
Custom environments

Variable Management

Environment variables
Global variables
Secret management
Variable interpolation

API Explorer

Endpoint Categories

Data Management

Upload datasets
List datasets
Update metadata
Delete datasets

Query Execution

Run SQL queries
Natural language queries
Query validation
Result pagination

Visualization

Create charts
Update visualizations
Export charts
Share links

User Management

User profiles
Permissions
API keys
Usage statistics

Response Handling

Response Formats

JSON (default)
CSV
XML
Binary data

Response Analysis

Response time breakdown
Header inspection
Size analysis
Performance metrics

Testing Workflows

Common Workflows

Dataset Upload Flow

Create dataset metadata
Upload data file
Configure schema
Verify upload

Query Execution Flow

Select dataset
Build query
Execute query
Retrieve results

Visualization Flow

Query data
Select chart type
Configure options
Generate visualization

Batch Operations

Bulk Testing

Multiple request execution
Parallel processing
Result comparison
Performance benchmarking

Test Suites

Create test collections
Automated testing
Regression tests
CI/CD integration

Debugging Tools

Request Inspector

Raw request data
Header analysis
Body formatting
URL encoding

Response Debugger

Status code details
Error messages
Stack traces
Debug information

Network Analysis

Request timing
DNS lookup
Connection time
Transfer speed

Collaboration

Share playground sessions
Public collections
Team workspaces
Read-only access

Documentation

Inline comments
Request descriptions
Example annotations
Tutorial creation

Security

Authentication Testing

API key validation
OAuth flows
JWT tokens
Session management

Permission Testing

Role-based access
Resource permissions
Scope validation
Error handling

Best Practices

Start Simple: Test basic endpoints first
Use Environments: Separate dev/prod testing
Save Requests: Build a library of common operations
Document Tests: Add descriptions and examples
Monitor Performance: Track response times

Integration

CI/CD Pipeline

Export tests
Command-line execution
Automated validation
Result reporting

Development Workflow

API-first development
Mock server integration
Contract testing
Version management

Next Steps

Configure API Authentication for secure access
Explore Auto-Generated APIs for your datasets

On this page