BDA API: Get data for specific URL, grouped by month

Analytics
BDA API: Get data for specific URL, grouped by month

BDA API: Get data for specific URL, grouped by month

steveniclas

I am trying to retrieve data (Page-Visits, Bounce-Rate, Revenue...) for one specific URL and a specific date range, grouped by month via PHP. I have set up the API to return data but can't find a way to get the desired outcome.

What's the best way to do this? I figured I could use a custom report, but as that needs a predefined date range, it doesn't seem to be the way to go.

krivera

steveniclas Are you returning any data?

steveniclas

krivera Yes I am. But I don't have the right foundation to build on yet.

I want to submit:

a URL from one of my websites
a date range

I want to recieve:

data (pageviews, revenue, bounce-rate ...) from the submitted URL, grouped by month

What's the right approach to achieve that goal with the Ezoic API? All I'm doing is trial & error, because I can't find anything about it in the docs.

krivera

steveniclas I have reached out to my team about this. I will update you once I hear back or have any questions!

krivera

steveniclas You can create a segment with URL filter (either using the API or in Big Data Analytics ) and then use that segment in getData request!

steveniclas

krivera So I will have to (automatically) create segments for all of my URLs? That means I will be creating thousands of segments. Is it meant to be like that?

Btw: I can't open Big Data Analytics:

Network error
You might be using an ad blocker. If you are, please disable it and try again.

Not using an ad blocker.

JeanPierre

This depends on the data in which you want to receive. If you want multiple URLs combined, you can make the URL rules more inclusive (start with, contains) or you can add them in advanced filters.
If you wish for data to be separated by URL, you will need to input each URL individually.

We also have the Pages section in Ezoic Analytics that views data for each page, but it can't be grouped by month.

For the issue with Ezoic Analytics not displaying, you can either try another network or another browser.

steveniclas

JeanPierre Okay, so I called createsegment with one URL to filter by. And then called getsegments to see if the segment was created succesfully.

https://api-gateway.ezoic.com/gateway/bdaservices/createsegment/?developerKey=xxx
array(
    "segmentFilters"=>array(
        "4"=>array(
            "FilterStringOperationId"=>"EQUAL",
            "Value"=>"https://www.myzitate.de/advent/"
        )
    )
);

Array
(
    [0] => stdClass Object
        (
            [SegmentName] => 
            [SegmentId] => 8019
            [IsCustom] => 1
            [CreatedOn] => 2023-01-19 07:47:44
            [LastModified] => 2023-01-19 07:47:44
            [SegmentFilters] => stdClass Object
                (
                    [4] => stdClass Object
                        (
                            [FilterIntOperationId] => <UNSET>
                            [FilterStringOperationId] => CONTAINS
                            [FilterValue] => 
                        )

                )

            [SegmentMultiFilters] => 
            [Error] => 
        )
....
)

Doesn't look right to me?

JeanPierre

Hey there! You should use operations for string filters, EQUALis for numbers.
Valueis not a valid field, it should be FilterValue, as in documentation.
I would also recommend using segmentNamefield, for easier differentiation

steveniclas

JeanPierre Got it. I created a new segment (ID 8083) that appears to be configured the way I want it (using FilterValue and "EXACTLY" instead of "EQUAL").

Now, when I try to get data with that segment:

https://api-gateway.ezoic.com/gateway/bdaservices/getdata/?reportName=revenueMonthly&developerKey=xxx
$data = array(
        "StartItem"=>0,
        "MaxItems"=>15,
        "Platform"=>"ALL",
        "DateGrouping"=>"MONTHLY",
        "SegmentIds"=>array(8083),
        "StartDate"=>"2022-12-01",
        "EndDate"=>"2023-01-31"
    );

This is what I get back:

[Message] => 
[Success] => 1
[Data] => Array
    (
    )

APerez

steveniclas According to our data team, the segment and request look to be configured correctly. They think that the expected result is due to https://www.myzitate.de/advent/ used in the segment immediately redirects to https://www.myzitate.de/adventsspruche/

steveniclas

APerez Next step.
I created a custom report (ID 3369):

array(
        "ReportTitle"=>"myZitate 2023",
        "ReportDateRange"=>array(
            "BaseSelectId"=>"BASE_CUSTOM",
            "BaseStartDate"=>"2022-01-01",
            "BaseEndDate"=>"2022-12-31"
        ),
        "Charts"=>array(
            array(
                "name"=>"myZitate Chart",
                "DimensionColumns"=>array(
                    array(
                        "Data"=>"report_month",
				        "Type"=>"string"
                    )
                ),
                "MetricColumns"=>array(
                    array(
                        "Data"=>"visits",
                        "Type"=>"number"
                    )
                    ,array(
                        "Data"=>"revenue",
                        "Type"=>"number"
                    )
                ),
                "Segments"=>array(),
                "Order"=>array(
                    "ColumnNumber"=>0,
                    "Direction"=>"DESC"
                )
            )
        )
    )

But when I'm trying to get data with it, only "visits" is returned. No "revenue":

stdClass Object
(
    [Message] => 
    [Success] => 1
    [Data] => Array
        (
            [0] => stdClass Object
                (
                    [report_month] => 2022, 11 (November)
                    [visits] => 558
                )

            [1] => stdClass Object
                (
                    [report_month] => 2022, 12 (December)
                    [visits] => 556
                )

            [2] => stdClass Object
                (
                    [report_month] => 2023, 01 (January)
                    [visits] => 6
                )
        )
)

In addition to that, when I try to add the bounce rate to my custom report:

                    ,array(
                        "Data"=>"bounce_rate",
                        "Type"=>"number"
                    )

It saves successfully, but I get this when I try to get data:

stdClass Object
(
    [Message] => error getting data
    [Success] => 
    [Data] => Array
        (
        )
)

JeanPierre

Hey there, our engineers have pushed a bug fix for this issue. You should now be able to create a new report and receive this data!

steveniclas

JeanPierre Great! Thanks! I can now request the data I want!
There's still one problem, though: Requesting data for two months of one single URL takes like 3-4 minutes. And requesting more months makes the request go to timeout. Is there a way to optimize the above mentioned way of retrieving data to make it faster?

Another question: How does "scroll_percent_vertical" work? I expected it to return values from ₀ to 100. But it returns values way over 100 (316 in one case) aswell.

JeanPierre

What is your request config when you get the timeout error?

Also, for scroll_percent_vertical, do you have infinite scrolling or add content after the user scrolls down the page?

steveniclas

JeanPierre This is the Custom Report I created (ID 3487):

array(
        "ReportTitle"=>"myZitate 2023",
        "ReportDateRange"=>array(
            "BaseSelectId"=>"BASE_CUSTOM",
            "BaseStartDate"=>"2022-01-01",
            "BaseEndDate"=>"2022-12-31"
        ),
        "Charts"=>array(
            array(
                "name"=>"myZitate 2023 Chart",
                "DimensionColumns"=>array(
                    array(
                        "Data"=>"report_month",
				        "Type"=>"string"
                    )
                ),
                "MetricColumns"=>array(
                    array(
                        "Data"=>"visits",
                        "Type"=>"number"
                    )
                    ,array(
                        "Data"=>"revenue",
                        "Type"=>"number"
                    )
                    ,array(
                        "Data"=>"bounce_rate",
                        "Type"=>"number"
                    )
                    ,array(
                        "Data"=>"scroll_percent_vertical",
                        "Type"=>"string"
                    )
                ),
                "Segments"=>array(),
                "Order"=>array(
                    "ColumnNumber"=>0,
                    "Direction"=>"DESC"
                )
            )
        )
    )

And this is how I request data:

https://api-gateway.ezoic.com/gateway/bdaservices/getdata/?customReportId=3487&developerKey=xxx
array(
        "StartItem"=>0,
        "MaxItems"=>15,
        "Platform"=>"ALL",
        "DateGrouping"=>"MONTHLY",
        "SegmentIds"=>array(8115),
        "StartDate"=>"2022-12-01",
        "EndDate"=>"2022-01-31"
    )

Requesting data for December + January works but already takes minutes to complete. Longer date ranges are timeouted.

Edit: The returned data seems to be cached on Ezoic's side. When I request the same dataset for a 2nd time, it's returned almost instantly.

There's no infinite scrolling on the page. The page height never changes during runtime.

JeanPierre

We've increased the timeout time from 15 minutes to 1 hour. Your request looks good. As for the scroll_percent_vertical, that column will be the total sum of percentages. scroll_percent_vertical_rate will get you the average for all the pageviews.