Particular Audience Particular Audience
Talk to us

AI for search, personalisation and retail media

A different store for every customer.

Bring what each shopper wants together with what your business needs.

Search, recommendations, retail media and promotions across your digital store and AI shopping experiences.

Retail Media Reporting Tool — Open Source on GitHub | Particular Audience

Extract retail media campaign data from Particular Audience as a command-line tool, a code library or scheduled Docker jobs, with CSV output. Built on the Retail Media Reporting API.

Open source on GitHub

Extract retail media campaign data from Particular Audience as a command-line tool, a code library or scheduled Docker jobs, with CSV output.

Source: https://github.com/Particular-Audience/retail-media-reporting-tool

Three ways to run it: On demand from the command line, imported as an SDK into your own TypeScript or JavaScript project, or on a schedule with Docker.

Suppliers and campaigns: Full supplier listings and campaign performance: impressions, clicks, spend and conversions.

Ad set and SKU level: Summary and detailed ad set metrics, plus product-level (SKU) performance.

Placement and product details: Combined reporting across every level of the campaign hierarchy.

Resilient extraction: OAuth 2.0 with automatic token refresh, configurable parallel calls and retries with exponential backoff.

Flexible dates and exports: Custom date ranges or presets (today, last month, month to date, year to date), as individual or combined CSV files.

Get API client credentials for the Retail Media Reporting API.

Run a report from the command line for the date range you need, or import the modules into your own code.

For regular reports, deploy the Docker image with a cron job or your orchestration tool.

Core dependency — Built on the Retail Media Reporting API: https://docs.particularaudience.com/retail-media/reporting/overview

Every number the tool exports comes from Particular Audience's Retail Media Reporting APIs, which measure campaign performance so you can optimise and show results to stakeholders.

Access uses the OAuth 2.0 client credentials flow: your server exchanges a client ID and secret for a short-lived bearer token, then sends it with each reporting request.

Client credentials and access tokens must never be exposed in browser code. Run the tool, or any custom integration, on a server you control.

Related: Retail Media Billing Extract, RevenueOS, Reporting & Forecasting.

What does the tool depend on? The Retail Media Reporting API. You need API client credentials, and the tool handles the OAuth 2.0 token flow for you.

Can I run it automatically every month? Yes. Deploy it with Docker and schedule it with cron or your orchestration tool.

How is it different from the Billing Extract? The Reporting Tool pulls performance metrics for analysis. The Billing Extract is a monthly file shaped for invoicing, with rates, discounts and invoice amounts per placement.