Understanding the Report Endpoint

8 views
Skip to first unread message

Danilo Lapa

unread,
Nov 6, 2025, 6:44:36 AM11/6/25
to EngageApi
Hi!

I need to understand how the API get the data daily, i ill give some examples:

This is my params request

           params = {
                'entityId': ENTITY_ID,
                'code': 'BRL',
                'fromDate': start_date.strftime('%Y%m%d'),
                'toDate': end_date.strftime('%Y%m%d'),
                'limit': limit,
                'offset': offset,
                'breakdowns': 'day,widget,doc'
            }

My question is, when I use `day` breakdown, am I retrieving the daily metrics value or the current metrics for that `doc_id` and that day?

My main question is whether the data I've already collected will be outdated or immutable.

Do you understand my question?



nadav.porat

unread,
Nov 6, 2025, 7:17:31 AM11/6/25
to EngageApi
Hey, nice to hear from you! :) The answer to your question is yes. 
The data you're getting includes a breakdown by day, widget, and doc, so you'll see a specific doc and widget for that day.

Nadav

Reply all
Reply to author
Forward
0 new messages