Legacy Dev Forum Posts

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

No sample variable for the expand of quality evaluations query API

  • 1.  No sample variable for the expand of quality evaluations query API

    Posted 06-05-2025 18:25

    jen | 2023-03-07 09:51:36 UTC | #1

    Hi,

    Now I'm working on the quality evaluations query API, but I found the document didn't provide any sample variable for the expand.

    GET /api/v2/quality/evaluations/query

    Could someone enlighten me?

    Thank You.

    tim.smith | 2023-03-07 15:24:40 UTC | #3

    The expand parameter is typically a discreet list of values, so it's most likely that it's simply not documented correctly in this case. If I can track down the info, I'll post back here with it. Otherwise, and preferably also, please open a case with Genesys Cloud Care to report the missing documentation as a bug because the values are supposed to be documented.

    jen | 2023-03-07 23:05:48 UTC | #4

    Hi Tim,

    Thank your advise, I already open a case with Genesys cloud care. I will update here if I got the feedback

    jen | 2023-03-08 04:02:02 UTC | #5

    Hi Tim,

    I found still got other parameters description is very not sufficient or even not descript anything. Below is the parameters I want to understand what is the meaning:

    1. sortBy - what is the available variable name? can sort by any field?
    2. nextPage - what is the meaning of next page token?
    3. evaluationState - what is the available variable name?
    4. maximum - what is the meaning of maximum?
    5. startTime / endTime is UTC or local time format?

    Could you enlighten me?

    Thank You.

    tim.smith | 2023-03-08 15:53:24 UTC | #6

    I was able to track down some answers about these params. I kindly ask that you still report these doc issues via Care to ensure that the updates are prioritized as a customer request. (Internal requests/reports do not carry as much priority as a customer report).

    • expand - evaluator , agent , or assignee
    • sortBy - this parameter doesn't actually do anything and needs to be removed from the docs
    • nextPage - this parameter doesn't actually do anything and needs to be removed from the docs
    • evaluationState - Pending , InProgress , or Finished
    • maximum - the maximum number of results to return
    • startTime / endTime - compared against the assigned date, ISO 8601 timestamps with or without a timezone (e.g. 2023-03-08T10:51:02-05:00 or 2023-03-08T15:51:02Z)

    jen | 2023-03-09 02:56:17 UTC | #7

    tim.smith, post:6, topic:18762
    evaluator , agent , or assignee

    Hi Tim,

    Thank your kind answer. I will follow up with support to request them update the document.

    Based on the support feedback, She give me the variable is evaluator,agent,evaluationForm. I think evaluationForm is invalid because I tried but nothing changes on the evaluationForm JSON response payload.

    Another thing is I found it is not working if I want to expand the evaluator and agent at the same time (expand=agent,evaluator). Is it the only can expand 1 only instead of 2? I found got similar issue report by post below:

    https://developer.genesys.cloud/forum/t/expand-query-results-by-2-or-more-results/3377/4

    Thank You.

    tim.smith | 2023-03-09 14:43:12 UTC | #8

    jen, post:7, topic:18762
    (expand=agent,evaluator). Is it the only can expand 1 only instead of 2?

    Please raise this with Care. The documentation is obviously lacking in general, but it's unclear if that's a bug or a feature. That's something Care will have to answer.

    system | 2023-04-09 14:44:05 UTC | #9

    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: 18762



Related Content