Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.
See: Consumer Surveys API Reference for consumersurveys.results.get
.
Synopsis
- type ResultsGetResource = ("consumersurveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ResultsGetRequest :> Get '[JSON] SurveyResults))))))) :<|> ("consumersurveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream))))))
- resultsGet :: Text -> ResultsGetRequest -> ResultsGet
- data ResultsGet
- rgSurveyURLId :: Lens' ResultsGet Text
- rgPayload :: Lens' ResultsGet ResultsGetRequest
REST Resource
type ResultsGetResource = ("consumersurveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ResultsGetRequest :> Get '[JSON] SurveyResults))))))) :<|> ("consumersurveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream)))))) Source #
A resource alias for consumersurveys.results.get
method which the
ResultsGet
request conforms to.
Creating a Request
Creates a value of ResultsGet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ResultsGet Source #
Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.
See: resultsGet
smart constructor.
Instances
Request Lenses
rgSurveyURLId :: Lens' ResultsGet Text Source #
External URL ID for the survey.
rgPayload :: Lens' ResultsGet ResultsGetRequest Source #
Multipart request metadata.