Retrieve group results for a topic

GET /api/v1/topics/{topic_code}/results/group-types/{group_type_code}

Path parameters

topic_code string Required

The code for a topic
group_type_code string Required

The code for the group type

Query parameters

date string

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

Responses

200

Results for topic on a particular date, broken down by group within the specified group type
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
  
  id integer
  
  Group ID
  
  code string
  
  Group code
  
  name string
  
  Group name

GET /api/v1/topics/{topic_code}/results/group-types/{group_type_code}

curl \
 -X GET https://app.fridaypulse.com/api/v1/topics/{topic_code}/results/group-types/{group_type_code} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "sample_date": "2019-07-03",
    "score": 75,
    "response_rate": 58,
    "response_count": 114,
    "total_count": 198,
    "group": {
      "id": 34,
      "code": "sales-team",
      "name": "Sales Team"
    }
  }
]

Response examples (200)

[
  {
    "sample_date": "string",
    "score": 42,
    "response_rate": 42,
    "response_count": 42,
    "total_count": 42,
    "topic": {
      "id": 42,
      "code": "string",
      "name": "string"
    }
  }
]