Start a conversation

Handling Date Ranges in API Queries

Overview

The question "Does the get worker form API use server sync date as start and end date instead of data entry date?" was raised. The API evaluates date ranges using the server's create/update timestamp, not the original data-entry time. This can lead to discrepancies when data is filled out offline and uploaded later. The solution involves querying by server time and categorizing data by entry time in the customer's system.

Information

Issue: Understanding date handling in API queries

Error Message: Not applicable

Cause: The API uses the server's create/update timestamp for date ranges, not the original data-entry time, leading to potential discrepancies when data is uploaded later.

Resolution Steps:

  1. Query by Server Time:
    • Use continuous UTC windows for querying.
    • Set the next call's start to the previous call's end (start inclusive, end exclusive).
  2. Categorize by Entry Time:
    • After receiving items, categorize them in your system by the form's entry/submission time to report by the business day.
  3. Example Windows (UTC):
    • Call 1: start=2025-08-12 00:00:00.000, end=2025-08-12 06:00:00.000
    • Call 2: start=2025-08-12 06:00:00.000, end=2025-08-12 12:00:00.000
  4. Best Practices:
    • Submit request times in UTC.
    • Use small windows to avoid the 500-item response cap and respect throttles (25 calls/minute, 250/hour per service).

Important: This behavior is documented in the Web Services Developer Guide. Only items received by the system during the time range are returned, and execution times may predate the query start due to offline/latency.

Frequently Asked Questions

How does the API handle date ranges in queries?
The API uses the server's create/update timestamp for date ranges, not the original data-entry time. This means data filled out offline and uploaded later will be returned based on the server's receive time.
How can I ensure I capture all data, including late uploads?
Use continuous UTC windows for querying by server time and categorize data by entry time in your system to report by the business day.
What should I do if I exceed the 500-item response cap?
Shorten the time window or filter by worker/group to manage high volume and avoid exceeding the cap.
Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Priyanka Bhotika

  2. Posted

Comments