Reporting

The Reporting API enables retailers to programmatically retrieve advertising performance data for campaigns running through their retail media program.

Reporting is available at multiple levels, allowing your integration to analyze performance across advertisers, campaigns, and products.

Reporting Structure

The API provides reporting at four levels:

Campaign Reporting

Campaign reporting provides performance data at the campaign level.

Use this report when your integration needs to analyze the performance of individual campaigns created for advertisers within your retail media program.

Common use cases include:

• Displaying campaign performance in an external platform

• Comparing performance across campaigns

• Monitoring campaign delivery and outcomes

• Exporting campaign data to your reporting or analytics environment

Campaign identifiers can be used to associate reporting results with campaign records maintained by your own systems.

Requesting a Report

Reporting requests use a defined reporting period and the applicable report endpoint.

1. Choose the Reporting Level

Select the report based on the level of data your integration needs:

• Campaign

2. Define the Reporting Period

Specify the date range for which performance should be returned.

Use a consistent reporting period when comparing results across multiple reports or integrating Symbiosys reporting with another reporting system.

3. Apply Applicable Filters

Use the filtering options supported by the selected report to limit results to the resources relevant to your integration.

Refer to the API Reference for the filters supported by each reporting endpoint.

4. Process the Results

Reporting results can be stored, displayed, or combined with data in your retailer's own systems.

Working with Reporting IDs

Reporting results contain resource identifiers that allow your integration to associate performance with resources managed through the API.

Depending on the report, these can include identifiers for resources such as advertisers, campaigns, or products.

Your retailer may also maintain its own identifiers for resources managed through Symbiosys. Where supported, these identifiers can help reconcile API reporting with records in your own systems.

Pagination

Reporting results may contain more records than can be returned in a single response.

Use the pagination parameters supported by the applicable endpoint to retrieve the complete result set.

When ingesting reporting data programmatically, your integration should continue requesting pages until all available results for the requested reporting period have been retrieved.

Reporting Considerations

When integrating reporting data into your own systems, consider the following:

Reporting Level

Choose the report that corresponds to the entity your integration needs to analyze. Avoid assuming that metrics from one reporting level can be directly compared with another without considering the underlying grain.

Attribution

Conversion and sales metrics reflect the attribution methodology applicable to the advertising activity being reported.

When presenting attributed performance outside of Symbiosys, ensure that users understand the attribution context associated with the data.

Data Freshness

Advertising performance can continue to change after activity occurs as delivery and attributed outcomes are processed.

Consider this when determining how frequently your integration retrieves recent reporting periods.

Historical Data

If your integration maintains its own reporting history, determine whether recent reporting periods should be refreshed to capture changes to previously reported performance.

API Reference

For reporting endpoints, request parameters, response schemas, available metrics, filters, and supported values, see the API Reference.