---
source_url: https://www.pubnub.com/docs/admin-api/illuminate-introduction
title: Illuminate Introduction
---

# Illuminate Introduction

> For AI agents: documentation index at https://www.pubnub.com/llms-full.txt

## 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](https://www.pubnub.com/docs/admin-api/list-business-objects.md)

Returns a list of all business objects for your account.

## [POST Create business object](https://www.pubnub.com/docs/admin-api/create-business-object.md)

Creates a new business object to capture and organize event data.

## [GET Get business object](https://www.pubnub.com/docs/admin-api/get-business-object.md)

Returns details for a specific business object.

## [PUT Update business object](https://www.pubnub.com/docs/admin-api/update-business-object.md)

Updates an existing business object.

## [DELETE Delete business object](https://www.pubnub.com/docs/admin-api/delete-business-object.md)

Deletes a business object and all associated metrics, decisions, and charts.

## [POST Validate JSON path](https://www.pubnub.com/docs/admin-api/validate-json-path.md)

Validates a JSON path expression for field extraction.

## [GET List metrics](https://www.pubnub.com/docs/admin-api/list-metrics.md)

Returns a list of all metrics for your account.

## [POST Create metric](https://www.pubnub.com/docs/admin-api/create-metric.md)

Creates a new metric for data aggregation.

## [GET Get metric](https://www.pubnub.com/docs/admin-api/get-metric.md)

Returns details for a specific metric.

## [PUT Update metric](https://www.pubnub.com/docs/admin-api/update-metric.md)

Updates an existing metric.

## [DELETE Delete metric](https://www.pubnub.com/docs/admin-api/delete-metric.md)

Deletes a metric and any associated decisions.

## [GET List decisions](https://www.pubnub.com/docs/admin-api/list-decisions.md)

Returns a list of all decisions for your account.

## [POST Create decision](https://www.pubnub.com/docs/admin-api/create-decision.md)

Creates a new decision for configuring rules, conditions, and actions based on events, metrics, or queries.

## [GET Get decision](https://www.pubnub.com/docs/admin-api/get-decision.md)

Returns details for a specific decision.

## [PUT Update decision](https://www.pubnub.com/docs/admin-api/update-decision.md)

Updates an existing decision.

## [DELETE Delete decision](https://www.pubnub.com/docs/admin-api/delete-decision.md)

Deletes a decision and removes its rules and actions permanently.

## [POST Get action data](https://www.pubnub.com/docs/admin-api/get-action-data.md)

Retrieves aggregated action execution counts for a decision within a date range.

## [GET Retrieve action log](https://www.pubnub.com/docs/admin-api/retrieve-action-log.md)

Retrieves historical action execution logs for a decision.

## [POST Reset action limits](https://www.pubnub.com/docs/admin-api/reset-action-limits.md)

Resets action execution limits so actions can fire again after hitting their `executionLimitType` cap.

## [GET List dashboards](https://www.pubnub.com/docs/admin-api/list-dashboards.md)

Returns a list of all dashboards for your account.

## [POST Create dashboard](https://www.pubnub.com/docs/admin-api/create-dashboard.md)

Creates a new dashboard to visualize metrics with optional decision overlays.

## [GET Get dashboard](https://www.pubnub.com/docs/admin-api/get-dashboard.md)

Returns details for a specific dashboard.

## [PUT Update dashboard](https://www.pubnub.com/docs/admin-api/update-dashboard.md)

Updates an existing dashboard.

## [DELETE Delete dashboard](https://www.pubnub.com/docs/admin-api/delete-dashboard.md)

Deletes a dashboard.

## [POST Execute query](https://www.pubnub.com/docs/admin-api/execute-query.md)

Executes a query definition without saving it.

## [GET List queries](https://www.pubnub.com/docs/admin-api/list-queries.md)

Returns a list of all saved queries for your account.

## [POST Create query](https://www.pubnub.com/docs/admin-api/create-query.md)

Creates and saves a query definition for reuse in dashboards and decisions.

## [GET Get query](https://www.pubnub.com/docs/admin-api/get-query.md)

Returns details for a specific saved query, including the full definition.

## [PUT Update query](https://www.pubnub.com/docs/admin-api/update-query.md)

Updates an existing saved query.

## [DELETE Delete query](https://www.pubnub.com/docs/admin-api/delete-query.md)

Deletes a saved query.

## [POST Execute saved query](https://www.pubnub.com/docs/admin-api/execute-saved-query.md)

Executes a previously saved query by ID and returns the result set.

## [POST Create predefined decision for query](https://www.pubnub.com/docs/admin-api/create-predefined-decision-for-query.md)

Creates a predefined decision scaffolded from this query's output fields.

## [GET Get query fields](https://www.pubnub.com/docs/admin-api/get-query-fields.md)

Returns the list of output fields produced by this saved query.

## [GET List Illuminate keysets](https://www.pubnub.com/docs/admin-api/list-illuminate-keysets.md)

Returns Illuminate-enabled keysets for the account.