Real-Time Reports

Real Time API reports let you view orders, revenue, units, custom events, instances, and other metrics with up to three correlated dimensions to create granular, real time dashboards with seconds of latency. Real-time reports are available for a rolling 20 previous hour period.

Real time reports operate most efficiently with frequent requests. We recommend between 15-30 seconds between updates.

Get current real time configuration

Call ReportSuite.GetRealTimeSettings

You'll receive an object with the current configuration, similar to the following:

Copy
{
    "real_time_settings":[
        {
            "min_granularity":1,
            "metric":"instances",
            "elements":[
                "prop2",
                "searchenginekeyword"
            ]
        }
    ]
}
Copied to your clipboard
{
    "real_time_settings":[
        {
            "min_granularity":1,
            "metric":"instances",
            "elements":[
                "prop2",
                "searchenginekeyword"
            ]
        }
    ]
}

Save a new configuration

Call ReportSuite.SaveRealTimeSettings

Send in a real_time_settings structure with the metrics and elements from the table in the next section that you would like to enable for real time reports.

You can provide a single metric with up to three correlated elements. Note that you do not need to include each correlated element for every report. For example, based on the struct in step one, you can report searchenginekeyword instances without reporting prop2 instances. Realtime configuration changes take 15 minutes to be reflected in reports.

Note: If the ui_report parameter is set to false, you must save at least one element and one metric or the configuration will be invalid, even though an error does not occur. If the ui_report parameter is set to true, you must save three elements and one metric or you will receive an error.

Run a real time report

Call Report.Run and set "source" to "realtime".

Copy
{
    "reportDescription": {
        "source": "realtime",
        "reportSuiteID": "examplersid",
        "metrics": [
            { "id": "revenue" }
        ]
    }
}
Copied to your clipboard
{
    "reportDescription": {
        "source": "realtime",
        "reportSuiteID": "examplersid",
        "metrics": [
            { "id": "revenue" }
        ]
    }
}

Minute Granularity

When requesting a Real-Time report, you can provide a "dateGranularity" of "minute:[interval]". The interval is an integer between 1-60 that specifies the interval to report. For example, 'minute:3' reports the request date range in 3-minute intervals.

Relative Dates

Real-Time Reports support relative dates for the Date, DateFrom, and DateTo parameters. For example, to report revenue between noon today and the current time in 3-minute intervals, you could use the following reportDescription:

Copy
{
    "reportDescription": {
        "source": "realtime",
        "dateFrom": "noon",
        "dateTo": "now",
        "dateGranularity": "minute:3",
        "reportSuiteID": "rsid",
        "metrics": [
            { "id": "revenue" }
        ]
    }
}
Copied to your clipboard
{
    "reportDescription": {
        "source": "realtime",
        "dateFrom": "noon",
        "dateTo": "now",
        "dateGranularity": "minute:3",
        "reportSuiteID": "rsid",
        "metrics": [
            { "id": "revenue" }
        ]
    }
}

Sort Options

Real-Time reports provide a number of sort options using the SortMethod property. It is a single concatenated string delimited by colons. The format is:

[algorithm]:[floorSensitivity]:[firstRankPeriod]:[algorithmArgument]

All components to this string are optional, reverting to its default value if omitted. If omitting parts of this string, make sure to still include the colon delimiters.

Copy
{
    "reportDescription": {
        "source": "realtime",
        "reportSuiteID": "rsid",
        "sortMethod": "mostpopular:.25:0:linear",
        "metrics": [
            { "id": "revenue" }
        ]
    }
}
Copied to your clipboard
{
    "reportDescription": {
        "source": "realtime",
        "reportSuiteID": "rsid",
        "sortMethod": "mostpopular:.25:0:linear",
        "metrics": [
            { "id": "revenue" }
        ]
    }
}

Totals for Items not Displayed (Everything Else)

You can include an optional "everythingElse" element to return metric totals for elements that are not included in the report. For example, if most popular is selected, this returns totals for values that are not in the most popular list.

Copy
{
    "reportDescription": {
        "source": "realtime",
        "reportSuiteID": "rsid",
        "sortMethod": "mostpopular:.25:0:linear",
        "metrics": [
            { "id": "revenue" }
        ],
        "elements":[
            {
                "id":"product",
                "everythingElse": true 
            }
        ]
    }
}
Copied to your clipboard
{
    "reportDescription": {
        "source": "realtime",
        "reportSuiteID": "rsid",
        "sortMethod": "mostpopular:.25:0:linear",
        "metrics": [
            { "id": "revenue" }
        ],
        "elements":[
            {
                "id":"product",
                "everythingElse": true 
            }
        ]
    }
}

Supported Metrics and Elements

The following table contains a list of the supported metrics and breakdowns available in Real Time Reports.

Last updated 2/6/2024

Was this helpful?

Yes

No