Ezoic Analytics API stopped working

Analytics
Ezoic Analytics API stopped working

Ezoic Analytics API stopped working

steveniclas

Hi, as of the 17th of July (22:07), the Ezoic Analytics API stopped working for me:

Creating a new segment
https://api-gateway.ezoic.com/gateway/bdaservices/createsegment/?developerKey=XXX

Array
(
    [segmentFilters] => Array
        (
            [4] => Array
                (
                    [FilterStringOperationId] => EXACTLY
                    [FilterValue] => https://www.myzitate.de/blue-protocol/
                )
        )
)

Returns:

stdClass Object
(
    [SegmentName] => 
    [SegmentId] => 0
    [IsCustom] => 0
    [CreatedOn] => 
    [LastModified] => 
    [SegmentFilters] => 
    [SegmentMultiFilters] => 
    [Error] => error creating segment
)

Retrieving data
https://api-gateway.ezoic.com/gateway/bdaservices/getdata/?customReportId=3487&developerKey=XXX

Array
(
    [StartItem] => 0
    [MaxItems] => 15
    [Platform] => ALL
    [DateGrouping] => MONTHLY
    [SegmentIds] => Array
        (
            [0] => XXX
        )

    [StartDate] => 2023-07-01
    [EndDate] => 2023-07-27
)

Returns:

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

Lilla

steveniclas Hey there, hope you're doing well today. 🙂

I'm sorry to hear that you're having this issue with our API. I will likely need to have our engineers take a look into this, as there have been a few issues with analytics the past couple weeks (both on our end and Google's) that could be contributing to this.

To make sure I'm supplying them with enough information as possible, can you please answer these questions:

I'm assuming this exact code worked previously, is that true?
Did anything change on your side around the time the code stopped working?
What timezone is the 22:07 time reported in?
Are you able to pull data from previous weeks still (ie. avoiding dates in July), using this code?

Let me know and I can pass this information on.

-Lilla

steveniclas

Yes, the exact same code has worked before, and stopped working around 2023-07-17 22:07:00 (CEST).
There were no changes on my side that I am aware of.
Pulling data from June doesn't work aswell (same error).

Lilla

steveniclas Thanks for that. I've passed all of this information on to our engineers, who will take a look into this. I'll let you know as soon as I have an update from them. 🙂

Thanks for your patience with this.

-Lilla

steveniclas

Are there any news about the issue? I'm really dependant on getting that data to see how new content is performing and to adapt the page on that.

Chelsea_W

steveniclas Hi there,
We have just heard back from our engineers. They have taken a look and have found it looks like the incorrect API call is being used.

They have said:
To create a segment you need to add a SegmentName Parameter so it can be referenced after creation.

For example you could use this

curl -X POST "https://api-gateway.ezoic.com/gateway/bdaservices/createsegment/?developerKey={API_KEY}" -H "Content-Type: application/json" --data '{ "SegmentName": "Blue Protocol Page", "SegmentFilters":{ "4":{"FilterStringOperationId": "EXACTLY", "FilterValue": "https://www.myzitate.de/blue-protocol/" }} }'

When Running this they received this response

{"SegmentName":"Blue Protocol Page","SegmentId":33932,"IsCustom":1,"CreatedOn":"2023-07-31 21:52:12","LastModified":"2023-07-31 21:52:12","SegmentFilters":{"4":{"FilterIntOperationId":"\u003cUNSET\u003e","FilterStringOperationId":"EXACTLY","FilterValue":"https://www.myzitate.de/blue-protocol/"}},"SegmentMultiFilters":null,"Error":""}

With that they where able to run the next call

curl -X POST "https://api-gateway.ezoic.com/gateway/bdaservices/getdata/?reportName=revenueDaily&developerKey={API_KEY}" -H "Content-Type: application/json" --data '{ "StartItem":0, "MaxItems":15, "Platform":"ALL", "DateGrouping":"MONTHLY", "SegmentIds":[33932], "StartDate": "2023-07-01", "EndDate": "2023-07-27" }'

steveniclas

Chelsea_W So "SegmentName" has now become mandatory. Why is this not communicated with people using the API, thus breaking their programs?

MichaelH

Very sorry for the confusion about this. I would be happy to bring this suggestion to our tech team.

steveniclas

In addition to not being able to create segments without a name anymore, all previously created segments stopped working. Which means I will have to recreate about 20,000 segments.

Seriously, that's ridiculous...

MichaelH

It appears that there was a recent change on July 17th. The problem arose from creating a new segment for each AP getReport request. This resulted in an excessive number of segments, exceeding 2000, and consequently caused significant loading delays, rendering the BDA practically unusable.

To address this issue, the tech team has implemented a limit on the maximum number of segments, which is now set to 300. Additionally, they have introduced a rule requiring segments to have a defined name.

steveniclas

MichaelH How is this not communicated??

If segments are the only way of looking up reports for specific URLs, then they cannot be limited to 300. That just renders the API useless for pages with more than 300 URLs.

Monica

steveniclas Our team is constantly working on small changes to improve overall user experience, and ensure our tools continue to work at their best. This fix prevented an issue where the segments were causing Big Data Analytics to be unusable for publishers with excess segments.

So we can advise further on alternatives for you, can you let me know what reports/data in particular you're looking for? You can view reports for individual pages here: https://analytics.ezoic.com/reports/content/allPages

steveniclas

I need to get data, grouped by month, for individual URLs via the API.

I was told by an Ezoic Employee that I'd have to create thousands of segments for what I'm trying to achieve:
https://community.ezoic.com/d/7174-bda-api-get-data-for-specific-url-grouped-by-month

steveniclas

Would it solve my problem, if I just took one segment, update it with a URL, request data for it, then update it to another URL, request data for it, and so on?

Lilla

steveniclas Yes, you could use the same segment and update it to cover multiple URLs - that should work. I'm sorry for the confusion with this, BDA API is not something that comes up very often; so there are a lot of nuances to it that agents may not be as familiar with as we should be, I apologise for the previous incorrect information.

-Lilla