You will always need an interval in your request, so that we know what period of time to query.
There are two scenarios:
1. startOfDayIntervalMatching: true
- Your results will contain interactions that started during your query interval.
2. startOfDayIntervalMatching: false (default)
- Your results will contain interactions that had any segment activity during your query interval.
I hope that helps!
------------------------------
Maisey Harris
Development Group Manager, Analytics UI & Reporting
Genesys
------------------------------
Original Message:
Sent: 07-08-2020 15:04
From: Mary Vo
Subject: Analytics API - Interval
@Maisey Harris I looked under the /api/v2/analytics/conversations/aggregates/query section of the API doc you linked, I did not see reference to startOfDayIntervalMatching. I'm curious does the body need to include both interval and startOfDayIntervalMatching? Also, would you be able to shed some light on the purpose of interval? Thank you.
------------------------------
Mary
Original Message:
Sent: 07-08-2020 14:24
From: Maisey Harris
Subject: Analytics API - Interval
Hi Mary,
There is an additional flag you can set on your POST request body: startOfDayIntervalMatching. See the API docs here. When that is true, you will only receive conversations that started during the interval, as opposed to receiving all conversations that had activity during that window. Hope that helps!
------------------------------
Maisey Harris
Development Group Manager, Analytics UI & Reporting
Genesys
Original Message:
Sent: 07-08-2020 13:03
From: Mary Vo
Subject: Analytics API - Interval
When making a POST call against https://api.mypurecloud.com/api/v2/analytics/conversations/details/jobs where the body references an interval:
{
"interval": "2020-06-01T00:00:00.000Z/2020-06-02T00:00:00.000Z"
}
I would expect to return a result set of conversations where the start timestamp falls within my interval.
According to the following documentation, The interval will filter based on the conversation start timestamp
https://developer.mypurecloud.com/api/rest/v2/analytics/query_syntax_detail.html
However, when I run GET https://api.mypurecloud.com/api/v2/analytics/conversations/details/jobs/########-####-####-####-############/results, I'm returning conversations with start dates outside of my interval. Have I misunderstood the purpose/intention of interval?
#Unsure/Other
------------------------------
Mary
------------------------------