Trying to understand the correct OData filter for agent state history in the last 24 hours. Using the .NET SDK. Calling GetAgentStateHistory with a filter on timestamp. Returning 400 Bad Request. JSON payload below. Is the filter syntax wrong? Or do I need a specific grant type?
var filter = "timestamp gt 2023-10-27T00:00:00Z";
var result = await client.Reporting.GetAgentStateHistoryAsync(filter);
According to the docs, they say the timestamp filter in CXone Reporting v2 requires strict ISO 8601 formatting with explicit timezone offsets or Z suffix, but more importantly, the OData parser is case-sensitive regarding property names. In the .NET SDK, GetAgentStateHistory maps to /api/v2/analytics/agents/summary, and the filter string you passed might be getting URL-encoded incorrectly by the client library if you are constructing it manually. The timestamp property is valid, but you must ensure the datetime string is wrapped in quotes if the underlying generator treats it as a string literal in the query string, though typically OData handles raw ISO strings. However, the real issue is likely the endpoint version mismatch or scope. Ensure your OAuth token includes analytics:report:read. Here is the corrected .NET snippet using the PureCloudPlatformClientV2 SDK to handle the filter safely:
using Platform.Client.V2;
using Platform.Client.V2.Api;
using Platform.Client.V2.Model;
// Initialize API client
var analyticsApi = new AnalyticsApi();
// Define the date range properly
var startDate = DateTime.UtcNow.AddDays(-1).ToString("yyyy-MM-ddTHH:mm:ssZ");
var endDate = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ");
// Construct OData filter string
// Note: Use 'timestamp' for agent state history
var filter = $"timestamp ge {startDate} and timestamp le {endDate}";
// Prepare request parameters
var agentId = "your-agent-id-here";
var body = new AgentStateHistoryQueryRequest
{
Filter = filter,
GroupBy = new List<string> { "agent", "state" }
};
try
{
var response = await analyticsApi.GetAgentStateHistory(agentId, body);
Console.WriteLine($"Retrieved {response.Entities?.Count} records.");
}
catch (ApiException ex)
{
Console.WriteLine($"API Error: {ex.Message}");
Console.WriteLine($"Response: {ex.ResponseContent}");
}
The key is using ge and le operators with properly formatted ISO strings. Check the official docs for OData syntax variations: https://developer.nicecxone.com/api/
The quickest way to solve this is to bypass the manual string interpolation for OData filters and use the SDK’s strongly-typed query builder if available, or strictly validate the ISO 8601 format before sending. The Reporting API v2 parser is notoriously strict about timezone offsets.
// Correct ISO 8601 with explicit Z suffix
var start = DateTime.UtcNow.AddDays(-1).ToString("yyyy-MM-ddTHH:mm:ssZ");
var filter = $"timestamp gt {start}";
// Ensure you are using the correct endpoint
// /api/v2/analytics/agents/summary
// Required Scopes: analytics:report:read
If the SDK is URL-encoding the > symbol incorrectly, try passing the filter via the dedicated QueryParameters object rather than concatenating it into the URL. The 400 error often stems from malformed OData expressions where the property name timestamp is not recognized due to casing or missing quotes in complex filters.
Warning: Agent state history queries can hit rate limits quickly. Always include a maxRecords parameter to prevent throttling during initial testing.