Synevyr Logo

Synevyr Public Data API

2025-08-13


🚀 TL;DR

These endpoints are public — no authentication or API keys required.

Example:

curl "https://api.synevyr.org/public/customers?page=1&page_size=50"

🌐 What Is the Synevyr Public Data API?

The Synevyr Public Data API provides open datasets you can query directly without signing in or using API tokens.
Data is paginated for efficient retrieval.


🛠️ Available Endpoints

1. /public/customers

Returns customer records for demonstration and analytics purposes.

GET /public/customers?page=1&page_size=50

Example Response:

{
  "table": "customers",
  "page": 1,
  "page_size": 50,
  "total_pages": 4,
  "total_items": 200,
  "data": [
    { "id": 1, "name": "John Doe", "email": "john@example.com" }
  ]
}

2. /public/leads

Contains marketing lead data from the Synevyr sample dataset.

GET /public/leads?page=1&page_size=50

3. /public/wc_orders

Contains e-commerce order data for testing and sample reporting.

GET /public/wc_orders?page=1&page_size=50

⚠️ Empty Dataset Behavior

If a table has no data, the API returns a usage block with:

  • Example queries
  • Allowed parameters
  • Message indicating no data is present

Example:

{
  "message": "No data available in table 'leads'.",
  "usage": {
    "endpoint": "/public/leads",
    "method": "GET",
    "parameters": {
      "page": "Page number. Default 1.",
      "page_size": "Rows per page. Default 50. Max 500.",
      "table": ["leads", "wc_orders"]
    },
    "examples": [
      "https://api.synevyr.org/public/analytics?table=leads&page=1&page_size=50",
    ]
  }
}

🔗 Helpful Links


📩 Need Help?

Email info@carpathian.ai with questions.
For large-scale data exports, contact our support team.