PredictHQ Retrieve Analysis

PredictHQ - Retrieve Analysis

This action returns a complete analysis of your Signal, which includes what your actual figures were, what could be expected, and what was in excess in terms of **demand**, **lead time** and **duration** and can be explained using events. Note that lead time (`lead`) and duration (`span`) analysis are only available when an `initiated` and `completed` dates are provided with data points, respectively. To retrieve a list of events that we estimate impacted your business at a specific date in the past, use the `` and `signal.explain` parameters with the events endpoint. Alternatively, to retrieve a list of predicted events that we estimate will impact your business in the future, use the `` parameter and the date range you wish a prediction for using `active` or `start`. See the events endpoint for more details. The `significance` parameter corresponds to percentage of variation in your data that is considered normal when computing excess that can be attributed to events. If you were to look at a normal distribution, it would correspond to the percentage of values that lie within a band around the mean. As an example: - ~68.27% = 1 standard deviation from the mean - ~95.45% = 2 standard deviations from the mean - ~99.73% = 3 standard deviations from the mean A high `significance` means that only extreme spikes and troughs will be attributed to events. We use 50% as a default, which corresponds to ~0.68 standard deviations.

Posted on:


Savings With


Processor Savings


Bandwidth Savings


Data Change

API Description




Event visibility yields higher returns & reduces operational costs. PredictHQ is the worlds largest source of intelligent event data making businesses smarter.

Curl command through

curl -v "{signal_id}/analysis/?X-Sd-Token={streamdata_token}"

API Specifications

Average Download Size

0 Kb

Average Download Time

0 second(s)

Test Conditions

Date of test

Duration of test

0 days

Polling frequency used for test

60 second(s)

Return to Main Page

Submit Your API

Join the gallery to find out how much you can save with