CIcint
Intelligent Calendar

Suggests an optimal fielding time range for a locale

Suggests an optimal time range to field a target group in a specific locale, taking into account local holidays and respondent activity patterns.

How to specify a time range:

  • To get a suggestion for a specific duration starting from now, provide the days parameter.
  • To get a suggestion within a specific date window, provide both the start and end parameters.

These options are mutually exclusive. A request that combines days with start or end, or that provides neither, returns a 400 error.

get/demand/intelligent-calendar/suggest-time-range

Request

Query parameters

daysinteger

The number of days to field the target group. Use this parameter OR both start and end.

startstring date-time

The start date for the fielding window (RFC3339 format). Use this parameter in conjunction with end, OR only use days.

endstring date-time

The end date for the fielding window (RFC3339 format). Use this parameter in conjunction with start, OR only use days.

localestring required

Unique text code of the locale.

Example:eng_us

Locale code.

Response

The suggested time range was calculated successfully.

suggested_startstring date-time

Starting timestamp of the suggested time range.

suggested_endstring date-time

Ending timestamp of the suggested time range.

timezonestring

The IANA time zone identifier for the suggested range (e.g., "Europe/London").

Example response

{
  "suggested_start": "2023-01-01T23:00:00.000Z",
  "suggested_end": "2023-01-10T23:00:00.000Z",
  "holidays": [
    {
      "date": "2023-01-01",
      "name": "New Year's Day",
      "respondent_rate": 0.65,
      "completes_rate": 0.54
    }
  ],
  "timezone": "Europe/London"
}

Changes

No recorded changes to this operation across all 1 revision of this API.