Skip to main content
Planned for Export API v1.4.0 — not yet available on api.honestly.com. Documented here so you can plan your integration. Watch Versioning for the release.
A recurring survey runs in cycles — each cycle opens, collects responses, and closes. This endpoint lists those cycles with their exact boundaries, so you can align an export to the periods your survey actually ran in rather than to arbitrary calendar dates. This is what makes a like-for-like period comparison possible: pass one cycle’s boundaries to /v1/scores, then the previous cycle’s.

Endpoint

Query Parameters

integer
Return only cycles of this survey. Survey IDs come from /v1/surveys. Omit to list cycles of every survey in the account.
integer
Maximum number of cycles to return per page. Accepts values from 0 to 1000. Defaults to 100.
integer
Number of cycles to skip before returning results. Defaults to 0.

Example Request

Example Response

Response Fields

integer
Total number of cycles matching the filter, for pagination.
array
Cycles are returned newest first.

Comparing a score to the previous period

Read the cycles, then call /v1/scores once per cycle using its boundaries:
There is no built-in comparison endpoint, because “previous period” means different things in different reports — the previous cycle, the same quarter a year earlier, a fixed baseline. Two calls cost one extra round trip and let you compare anything to anything.Each call is anonymity-checked independently, so a comparison can legitimately return a number for one period and a suppressed value for the other.