We stopped seeing the query_summary section of the response data from the Get ZVA engagements endpoint. We see the new intent_summary section, but it looks like the query_summary section has disappeared. It’s not returned in any of our engagement data. Is there a bug? Or did it get removed?
It sounds like the query_summary section might have been deprecated or replaced with the intent_summary section in the Get ZVA engagements endpoint. Here’s how you can investigate and address the issue:
1. Check the API Documentation
API providers often update their documentation to reflect changes. Look for a changelog or release notes that mention the removal or replacement of the query_summary section. If you have access to the API documentation, verify if query_summary has been officially removed.
2. Versioning
If the API uses versioning, ensure you’re using the correct version. Sometimes, older endpoints or fields are retired in newer versions. Check if an earlier version of the API still supports query_summary.
3. Contact Support
If the documentation doesn’t clarify the issue, reach out to the API support team. Provide specific details, including the endpoint you’re using and examples of the response data. They should confirm whether this is a bug or an intentional change.
4. Fallback to intent_summary
If query_summary has been replaced, you might need to adjust your application to use the intent_summary field instead. Compare the structure and data of both fields to see if intent_summary meets your needs.
For anyone working on music or tech apps, such as the Blackhole music app staying up-to-date with API changes is critical to maintaining functionality. On my blog, I share tips for managing apps and adapting to technical changes: Blackhole app
HI @jeff.ricards
Thanks for reaching out to us, I was able to find in our changelog that the intent_summary section was recently added to this endpoint, but I did not find anything about the query_summary section.
Would you be able to share a response body where you are missing this data and the tracking ID associated with the request please
Hi Elisa,
Yes I saw the entry in the change log for the intent summary section, and I also couldn’t find anything about the query summary section in any recent changelog entries. I do see the API docs detail the engagement report endpoint data has both a query_summary section and intent_summary section.
Here’s an example of the engagement data we’re seeing now:
{'campaign_name': '<campaign_name>',
'duration': 2442,
'end_time': '2025-01-20T03:56:18Z',
'engagement_id': 'rVb0iktBQNSs_Otwo80YNg',
'global_variables': [{'group_id': '98dc073a-077f-4dc0-9fa7-4570463198ae',
'group_name': 'dreamhost',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': 'en',
'variable_id': '65b0f379-f9e0-4b77-80b0-0ce19bc44fa7',
'variable_name': 'language'},
{'group_id': '98dc073a-077f-4dc0-9fa7-4570463198ae',
'group_name': 'dreamhost',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<customer_webid>',
'variable_id': '323510e2-79d0-41a6-9b42-e3e98309dd80',
'variable_name': 'username'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<region_code>',
'variable_id': 'eb38d7c1-fcbe-424c-aa1a-da5245f645a0',
'variable_name': 'regionCode'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<postal_code>',
'variable_id': 'd8ef703b-e492-428c-9ea7-933bfbf69f34',
'variable_name': 'postalCode'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<campaign_id>',
'variable_id': 'd0a52429-fac2-478f-9e28-c8f3e71ac993',
'variable_name': 'campaignId'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<timezone>',
'variable_id': 'afe4d05a-b118-48bf-bdea-d42b4e0c7a65',
'variable_name': 'timezone'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<panel_url>',
'variable_id': 'a77e7e13-1463-4628-94d2-6134e7e2d266',
'variable_name': 'referrer'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<continent>',
'variable_id': 'a4ea78e6-6853-4be5-af5c-864a6fc0c037',
'variable_name': 'continentCode'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<ip_address>',
'variable_id': '9cb821a2-795f-498d-8ffb-17c1e0c54bcf',
'variable_name': 'ipAddress'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<city_name>',
'variable_id': '9b7d0314-7f80-409c-97e6-2afd3bd45e16',
'variable_name': 'cityName'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': 'Mac',
'variable_id': '97cdb7f3-b0b7-4131-bf5a-dacb21d3d48c',
'variable_name': 'operatingSystem'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': 'en-US',
'variable_id': '86a373d7-b165-4309-855e-4fcd81bde416',
'variable_name': 'language'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': 'Safari 18',
'variable_id': '690f0591-e9fc-4705-8d32-c24924e09842',
'variable_name': 'browser'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<country_code>',
'variable_id': '5a7a8484-e0f3-4b2c-8453-b998a8387084',
'variable_name': 'countryCode'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': 'rVb0iktBQNSs_Otwo80YNg',
'variable_id': '52c5ef3a-3fad-4d84-8d51-c262d114cc96',
'variable_name': 'engagementId'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<zva_start_url>',
'variable_id': '47101e3c-8b6a-429a-b27a-0e46536b9d03',
'variable_name': 'startPage'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<campaign_name>',
'variable_id': '404e211f-a6b2-4dca-ae7f-949f5edb0c99',
'variable_name': 'campaignName'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<region_name>',
'variable_id': '3f9d84ed-62ab-4b33-809f-739e4b2e7d73',
'variable_name': 'regionName'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<zva_panel_start_title>',
'variable_id': '363e34c5-c9f5-44c9-81b2-8d35b67ab031',
'variable_name': 'startPageTitle'},
{'group_id': '42a0da72-8d41-4a41-8100-5ee3d65e9854',
'group_name': 'Consumer',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<consumer_id>',
'variable_id': '32b9469d-fe39-4daf-83ad-5ccd6f6d96aa',
'variable_name': 'consumerId'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<lat_long>',
'variable_id': '2617557c-19aa-4013-802f-cd8104eddc94',
'variable_name': 'latLong'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<country_name>',
'variable_id': '1d164bd6-b471-4cb8-b8ec-cceffc1493b6',
'variable_name': 'countryName'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': 'en-US',
'variable_id': '1bed1fa0-fc37-4dc8-850c-e66ea6ce958c',
'variable_name': 'locale'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': 'Desktop',
'variable_id': '17447faf-f74a-420d-96de-563b45a260da',
'variable_name': 'device'},
{'group_id': 'd388aa00-afc1-4bc5-97ed-75bb134e38c8',
'group_name': 'Engagement',
'need_mask': False,
'need_store': True,
'type': 'global',
'value': '<continent_name>',
'variable_id': '09d80aaa-e1eb-4556-8409-2a7d16241ef2',
'variable_name': 'continentName'},
{'group_id': '98dc073a-077f-4dc0-9fa7-4570463198ae',
'group_name': 'dreamhost',
'need_mask': False,
'need_store': True,
'type': 'custom',
'value': '<url>',
'variable_id': 'd82a742d-5163-4de5-bab4-ed54d7771bf2',
'variable_name': 'url'}],
'intent_summary': {'count': 3,
'intents_matched': [{'accuracy': 0.94602435827255,
'intent_id': '5qeocEapS1uHjoYnQgrYFg',
'intent_name': 'FTP credentials',
'intent_type': 'custom_intent',
'system_intent': False},
{'accuracy': 0.86764234304428,
'intent_id': '7wrNercQSBmlc26eo7coKQ',
'intent_name': 'Domains questions',
'intent_type': 'custom_intent',
'system_intent': False},
{'accuracy': 1,
'intent_id': 'MYEX9IMTTmaqWYyNZ-LbEw',
'intent_name': 'Contact Support',
'intent_type': 'custom_intent',
'system_intent': False}]},
'language_code': 'en-US',
'launch_url': '<launch_url>',
'outcome': 'assistanceRequested',
'start_time': '2025-01-20T03:15:35Z'}
You can see it’s got the intent summary section, but the query summary section is gone. All our engagment data looks like this now.
@elisa.zoom any thoughts here?
hey @jeff.ricards
I have created a ticket to report this issue but still waiting to hear back (ZSEE-155322 internal ticket number for reference)
I will get back to you when i hear back from the team
1 Like
Hi @jeff.ricards
Thanks for your patience here, I was able to hear back from our Engineering team and we removed query details in the response for this API in October 2024.
In its place, we released a new endpoint for this:
I will reach out to our Documentation team to remove these fields from the response so it does not create confusion
Ok, thanks! Yah I’ve seen that query details endpoint. We didn’t really have a need to hit that since the query_summary section in the engagement data gave us the aggregation of the query data we needed. We’ll just have to hit that now to get our query totals.
I appreciate all your follow up with this issue Elisa.
1 Like
This topic was automatically closed 24 hours after the last reply. New replies are no longer allowed.