Retrieving Category and Section names in Articles API | Community
Skip to main content

Retrieving Category and Section names in Articles API

  • November 16, 2022
  • 4 replies
  • 0 views

Joel13

We integrate with Yext to provide a federated search experience in our Zendesk Help Center. We want to feature faceted filtering in Zendesk article search results based on articles' categories and sections (the names, not the numerical id's). The Yext integration relies on data delivered via our articles.json that does not appear to currently deliver this information.

Is it possible to include this data in the API response? If so, how?

Thanks!

4 replies

Greg29
  • November 17, 2022

Hi Joel! The closest option that we would have would be to sideload the sections or categories, as we document here. The syntax would be to append the following at the end of the url: `?include={name}`


Joel13
  • Author
  • November 17, 2022

Interesting, thanks, @greg29. Would this actually help accomplish my intention -- to associate each article in the Articles call with a specific category and section name? At first glance, it doesn't look that way, but I'm a little out of my technical depth here.


Greg29
  • November 17, 2022
I'm not familiar with Yext or the available options to iterate through the data, but this does return the data in a single API request. Since this is a sideload, the sections/categories are returned in a separate object, so the article name would not be returned in each individual article's object.

Joel13
  • Author
  • November 17, 2022

Ah, I see. Yeah, Yext or not, the idea would be to glean from what is returned per article what section and category each is in in order to leverage those attributes. Unfortunate that it doesn't work like that unless you can offer another way to return the data, but at least I know now. Thanks.