Retrieve results for all topics for everyone

GET /api/v1/results

Query parameters

  • date string

    Optional. The date for the results. In YYYY-MM-DD format. Defaults to latest results date.

Responses

  • 200

    Results for everyone on a particular date, broken down by topic

    Hide response attributes Show response attributes array[object]
    • sample_date string

      The date when the question was asked

    • score integer | null

      The score between 0 and 100. Null if no score is available.

    • response_rate integer

      Percentage of people who responded

    • response_count integer

      Number of people who responded

    • total_count integer

      Total number of people who could respond

    • topic object
      Hide topic attributes Show topic attributes object
GET /api/v1/results 
curl \
 -X GET https://app.fridaypulse.com/api/v1/results \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "sample_date": "2019-07-03",
    "score": 75,
    "response_rate": 58,
    "response_count": 114,
    "total_count": 198,
    "topic": {
      "code": "happiness",
      "name": "Happiness"
    }
  }
]
Response examples (200) 
[
  {
    "sample_date": "string",
    "score": 42,
    "response_rate": 42,
    "response_count": 42,
    "total_count": 42,
    "topic": {
      "code": "string",
      "name": "string"
    }
  }
]