Conviva DPI Flow API

 

DPI Flow API

The DPI Flow API allows customers to easily access real-time aggregate metrics for any Flow, to populate internal dashboards or measure infrastructure performance. The API supports both real-time and historical data queries.

The API has two stages:

  • Get all Flow names

  • Get historical/real-time metric data for a Flow

Note: Conviva DPI Flow API supports retrieving real-time data up to the last 15 minutes, and historical data up to the last 7 days, with a maximum query interval of 1 hour.

API Authentication

DPI Flow API requires authentication (using the HTTP Authorization Basic scheme) to ensure secure access. The Authorization string should be included in the request header for each API call. Authenticate with your Client ID and Client Secret. These credentials authenticate the API requests at the account level by inheriting the permissions of the Conviva Pulse account.

API Endpoint

Fetch the list of available Flow Models associated with a customer account. Each Flow model provides metadata that includes Flow ID, label, metrics, and dimensions, used for constructing the Flow metric API queries.

 

The Flow API supports only https GET method to retrieve Flow models and metrics related to a Flow.

GET Endpoints
List of Flow models

https://api.conviva.com/flow-data/metadata/flow-models
Historical metric data of a Flow model, in time series format https://api.conviva.com/flow-data/metrics/{flow_entity_id}/{start_timestamp}_to_{end_timestamp}
Historical metric data of a Flow model, grouped by a dimension format https://api.conviva.com/flow-data/metrics/{flow_entity_id}/{start_timestamp}_to_{end_timestamp}/group-by/{group_by_dimension}
Real-time metric data of a Flow model, in time series format https://api.conviva.com/flow-data/real-time-metrics/{flow_entity_id}/{relative_time_interval}
Real-time metric data of a Flow model, grouped by a dimension https://api.conviva.com/flow-data/real-time-metrics/{flow_entity_id}/{relative_time_interval}/group-by/{group_by_dimension}

This endpoints helps you to discover the Flow models and historical/real-time metric data associated to a Flow, configured for the account. The retrieved flow_model_id is essential when using other endpoints to fetch historical or real time metric data of a Flow model.

API Response Fields

DPI Flow API returns the following information:

  • id: Unique identifier for the Flow model.

  • label: Human-readable name. This you can change during Flow activation.

  • metrics: List of supported Flow metrics (For example, init, complete, avg_duration, success, error, percentage)

  • dimensions: Available breakdown dimensions derived from Flow events.

  • is_conviva_defined: Boolean flag indicating whether the model is pre-defined by Conviva or created by the customer.

  • created_at / updated_at: Timestamps for when the model was created and last updated (in both epoch and ISO 8601 formats).

 

See

Getting started

To get started with DPI Flow APIs, contact your Account Team.

 

 

DPI DPI DPI Flow Flow Flow API API API Data Feed