Legacy Dev Forum Posts

 View Only

Sign Up

How to see a list of fields that the api is supposed to output?

  • 1.  How to see a list of fields that the api is supposed to output?

    Posted 06-05-2025 18:26

    ohp | 2023-06-30 02:15:07 UTC | #1

    Instead of using the API explorer directly and inputting in the required fields to call a specific api, is there a documentation or webpage that we can use to view the list of fields the specific api is supposed to output?


    Eos_Rios | 2023-06-30 12:23:37 UTC | #2

    https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis

    Set Reading Mode to ON.


    tim.smith | 2023-06-30 13:09:42 UTC | #3

    ohp, post:1, topic:20782
    view the list of fields the specific api is supposed to output?

    You don't need reading mode to view the output; it's visible either way. If you look in the API Responses section, you'll see each response code has schema documentation:


    Eos_Rios | 2023-06-30 13:53:49 UTC | #4

    tim.smith, post:3, topic:20782
    You don't need reading mode to view the output; it's visible either way.

    True, but it's clearer and less cluttered with it on, IMO.


    tim.smith | 2023-06-30 13:54:38 UTC | #5

    The response doesn't change based on reading mode. Only the request does.


    Eos_Rios | 2023-06-30 13:58:24 UTC | #6

    ohp, post:1, topic:20782
    Instead of using the API explorer directly and inputting in the required fields

    Yeah, I misread his request and thought he was looking for the request parameters without the GUI.


    tim.smith | 2023-06-30 14:56:41 UTC | #7

    Yeah, there's mention of both. We've got it covered regardless of which part was the intended question! :slight_smile:

    There is one more option for requests: if you turn reading mode off and then pro mode on, then you get the plain request schema documentation and the JSON editor with no request wizard.


    system | 2023-07-31 14:56:49 UTC | #8

    This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.


    This post was migrated from the old Developer Forum.

    ref: 20782