Illuminate
The PubNub Illuminate REST API provides programmatic access to create, manage, and monitor your real-time analytics and decision-making infrastructure.
Use this API to define the data you capture (business objects), transform that data into aggregations (metrics), make real-time decisions (decisions), and visualize everything (dashboards). The typical workflow is linear and repeatable across projects.
GET List business objects
Returns a list of all business objects for your account.
POST Create business object
Creates a new business object to capture and organize event data.
GET Get business object
Returns details for a specific business object.
PUT Update business object
Updates an existing business object.
DELETE Delete business object
Deletes a business object and all associated metrics, decisions, and charts.
POST Validate JSON path
Validates a JSON path expression for field extraction.
GET List metrics
Returns a list of all metrics for your account.
POST Create metric
Creates a new metric for data aggregation.
GET Get metric
Returns details for a specific metric.
PUT Update metric
Updates an existing metric.
DELETE Delete metric
Deletes a metric and any associated decisions.
GET List decisions
Returns a list of all decisions for your account.
POST Create decision
Creates a new decision for configuring rules, conditions, and actions based on events, metrics, or queries.
GET Get decision
Returns details for a specific decision.
PUT Update decision
Updates an existing decision.
DELETE Delete decision
Deletes a decision and removes its rules and actions permanently.
POST Get action data
Retrieves aggregated action execution counts for a decision within a date range.
GET Retrieve action log
Retrieves historical action execution logs for a decision.
POST Reset action limits
Resets action execution limits so actions can fire again after hitting their `executionLimitType` cap.
GET List dashboards
Returns a list of all dashboards for your account.
POST Create dashboard
Creates a new dashboard to visualize metrics with optional decision overlays.
GET Get dashboard
Returns details for a specific dashboard.
PUT Update dashboard
Updates an existing dashboard.
DELETE Delete dashboard
Deletes a dashboard.
POST Execute query
Executes a query definition without saving it.
GET List queries
Returns a list of all saved queries for your account.
POST Create query
Creates and saves a query definition for reuse in dashboards and decisions.
GET Get query
Returns details for a specific saved query, including the full definition.
PUT Update query
Updates an existing saved query.
DELETE Delete query
Deletes a saved query.
POST Execute saved query
Executes a previously saved query by ID and returns the result set.
POST Create predefined decision for query
Creates a predefined decision scaffolded from this query's output fields.
GET Get query fields
Returns the list of output fields produced by this saved query.
GET List Illuminate keysets
Returns Illuminate-enabled keysets for the account.