›API reference

Get started

  • Introduction to Imply Polaris
  • Quickstart
  • Navigate the console
  • Key concepts

Data

  • Overview
  • Create a schema
  • Data partitioning
  • Introduction to rollup
  • Replace data
  • Supported data formats

Analytics

  • Overview
  • Manage data cubes
  • Visualize data
  • Dimensions
  • Measures
  • Dashboards
  • Visualizations reference
  • Query data

Monitoring

  • Overview

Management

  • Overview

Billing

  • Overview
  • Polaris plans
  • Estimate project costs
  • Manage billing and payments

Security

  • Overview
  • Add users to an organization
  • User roles reference
  • Manage user groups
  • Enable SSO
  • SSO settings reference

Developer guide

  • Overview
  • Authenticate API requests
  • Create a table
  • Get table ID
  • Define a schema
  • Upload files
  • Ingest to table
  • Push event data
  • Query data
  • Link to BI tools
  • Connect over JDBC

API reference

  • Overview
  • Reference index
  • Events API
  • Files API
  • Ingestion Jobs API
  • Ingestion Templates API
  • Performance API
  • Query API
  • Tables API
  • Common object definitions

    • Table
    • TableRequest
    • RollupSchema
    • IngestionJobSpec
    • CsvFormatSettings
    • JsonFormatSettings
    • TimestampMapping

Product info

  • Release notes
  • Known limitations

Events API

Use the Events API for push stream ingestion. Push stream ingestion loads your data from a source data stream to a destination table in Imply Polaris. See Push event data by API for more details and examples.

All URIs are relative to https://api.imply.io/v1

Push events to a table

Send a POST request to the Events API and pass the event data in the payload. Each request payload is limited to 1 MB in size. Each Polaris organization is limited to 83,334 calls per minute. We recommend that you include up to 60 events in a batch per request. This effectively limits your rate to approximately 5 million events per minute.

See Event payload requirements for limitations of the request payload.

URL

POST /events/{tableId}

Parameters

Path parameters

  • tableId   type: String   required
    The ID of the table for which to push data.

Request body

  • type: raw JSON object
    Data to be pushed to the table in Polaris in newline-delimited JSON format. The JSON body must include the event time as a key-value pair, where the __time key is mapped to the timestamp in ISO format.

Responses

200 SUCCESS
404 ERROR
429 ERROR


OK.



Not Found.



Too Many Requests.

Example body:

{
"message": "API rate limit exceeded"
}

See View rate limits for how to view request rate limits and time until the limit resets.


Sample request

curl --location --request POST 'https://api.imply.io/v1/events/149d245a-1207-4946-9057-88c56354482c' \
--header 'Authorization: Bearer <Bearer Token>' \
--header 'Content-Type: application/json' \
--data-raw '{"__time":"2015-09-12T00:46:58.771Z","channel":"#en.wikipedia","added":36,"deleted":0}'
← Reference indexFiles API →
  • Push events to a table
    • URL
    • Parameters
    • Responses
    • Sample request
Key links
Try ImplyApache Druid siteImply GitHub
Get help
Stack OverflowSupportContact us
Learn more
BlogApache Druid docs
Copyright © 2022 Imply Data, Inc