DataFlow

Platform

Features

Resources

Pricing

View Demo

DataFlow

Search api documentation...

Getting Started

Our REST API enables you to integrate real-time analytics into your applications. Follow these steps to get started with the API integration.

Get your API key

1. Get your API key

Authentication

Authentication

2. Authentication

Include your API key in the request headers

3. Make API Calls

Start making requests to our endpoints

Authentication

API Key Authentication

To authenticate requests, include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.dataflow.com/v1/data

Endpoints

GET

/v1/data

Retrieve all data entries

POST

/v1/data

Create a new data entry

PUT

/v1/data {id}

Update existing data entry

DELETE

/v1/data {id}

Delete a data entry

Data Models

Data Entry Models

{

"id" : "string" ,

"name" : "string" ,

"description" : "string" ,

"created_at" : "datetime" ,

"updated_at" : "datetime" ,

}

{

"id" : "string" ,

"name" : "string" ,

"description" : "string" ,

"created_at" : "datetime" ,

"updated_at" : "datetime" ,

}

Error Handling

Error Responses

The API uses standard HTTP response codes to indicate the success or failure of requests.

2xx: Success
4xx: Client errors
5xx: Server errors

The API uses standard HTTP response codes to indicate the success or failure of requests.

2xx: Success
4xx: Client errors
5xx: Server errors

Rate Limiting

API Rate Limits

The API is rate limited to 1000 requests per hour per API key. You can check your current rate limit status in the response headers:

X-RateLimit-Limit: Total requests allowed per hour
X-RateLimit-Remaining: Remaining requests for the current hour
X-RateLimit-Reset: Time when the rate limit will reset (Unix timestamp)

The API is rate limited to 1000 requests per hour per API key. You can check your current rate limit status in the response headers:

X-RateLimit-Limit: Total requests allowed per hour
X-RateLimit-Remaining: Remaining requests for the current hour
X-RateLimit-Reset: Time when the rate limit will reset (Unix timestamp)

Webhooks

Event Notifications

Set up webhooks to receive real-time notifications for specific events:

data.created
data.updated
data.deleted

Set up webhooks to receive real-time notifications for specific events:

data.created
data.updated
data.deleted

Configure Webhooks

API Reference