Gen-Endpoint
Back to API List
Data Export API
Export data in various formats (CSV, JSON, XML) with filtering and field selection.
Data
Internal API - Hosted by this App
API Endpoints & Usage
Explore and interact with the available endpoints for the Data Export API. These API routes are live! The paths shown below are relative to your application's base URL. For example, if this application is hosted at https://gen-endpoint.com, an endpoint path for this API, such as /api/export/{format}, would be accessible at https://gen-endpoint.com/api/export/{format}. You can use the "Try it out" section for each endpoint or use tools like curl, Postman, or your browser's address bar (for GET requests) to interact with them.
POST

/api/export/{format}

Request data export in CSV, JSON, or XML format. Replace {format} with "csv", "json", or "xml".

Show Static Examples

Example Request Body:

Path: /api/export/csv
Body: {
  "entity": "users",
  "filters": {"role": "admin"},
  "fields": ["name", "email", "createdAt"]
}

Example Response:

{
  "jobId": "export_123",
  "status": "processing",
  "format": "csv",
  "entity": "users",
  "totalRecords": 150,
  "estimatedCompletion": "2024-08-16T12:05:00Z",
  "statusUrl": "/api/export/status/export_123"
}
Try it out

Replace placeholders (e.g., {userId}) with actual values in the path above.

GET

/api/export/{format}

Get information about the specified export format. Replace {format} with "csv", "json", or "xml".

Show Static Examples

Example Response:

{
  "format": "csv",
  "mimeType": "text/csv",
  "description": "Comma-separated values format",
  "supportedEntities": [
    "users",
    "products",
    "orders"
  ]
}
Try it out

Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).

GET

/api/export/status/{jobId}

Check export job status and get download link if completed. Replace {jobId} with an actual job ID like `export_123`.

Show Static Examples

Example Response:

{
  "id": "export_123",
  "format": "csv",
  "entity": "users",
  "status": "completed",
  "totalRecords": 150,
  "createdAt": "2024-08-16T12:00:00Z",
  "completedAt": "2024-08-16T12:04:30Z",
  "downloadUrl": "/api/export/download/export_123",
  "fileSize": 2048000,
  "filename": "users-export-2024-08-16.csv",
  "mimeType": "text/csv"
}
Try it out

Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).

DELETE

/api/export/status/{jobId}

Cancel an export job. Replace {jobId} with an actual job ID.

Show Static Examples

Example Response:

{
  "message": "Export job export_456 cancelled successfully",
  "jobId": "export_456",
  "status": "cancelled"
}
Try it out

Replace placeholders (e.g., {userId}) with actual values in the path above.