As a user of the Brand Metrics web portal, you need to regularly view and download reports for your completed measurements. To automate this process and gain a better overview, you can use the endpoints in the Brand Metrics Report API. By utilizing the API endpoints, you can retrieve various information about your completed measurements, such as details, benchmarks, statistics and survey responses. By building a report dashboard using this data, you can quickly and easily access the information you need without having to manually download the reports.
To retrieve a comprehensive list of all available reports, a GET request can be made to the /api/v1/report endpoint. This will provide a overview of the available reports, including the report name, type, brand and a brief description of its properties.
curl "<https://api.brandmetrics.com/api/v1/report>" -H "Content-Type: application/json" -H "X-API-KEY: {api_key}" -H "Content-Type: application/json" -X GET
For a more detailed view of each report, the /api/v1/report/details endpoint can be called. This endpoint will provide a comprehensive view of the report and their properties.
curl "<https://api.brandmetrics.com/api/v1/report/details>" -H "Content-Type: application/json" -H "X-API-KEY: {api_key}" -H "Content-Type: application/json" -X GET
To obtain detailed information regarding a specific report, you can make a GET request to the endpoint /api/v1/report/{measurement_id}. This endpoint accepts the measurement_id of the report as a path parameter which specifies which report's information you want to retrieve.
curl "<https://api.brandmetrics.com/api/v1/report/detailed/{measurement_id}>" -H "Content-Type: application/json" -H "X-API-KEY: {api_key}" -H "Content-Type: application/json" -X GET
The endpoint "/api/v1/report/{measurementid}/benchmark" allows you to retrieve the benchmark data for a specific report. You use the measurementid as a path parameter in the endpoint URL to specify which report's benchmark data you want to retrieve.
curl "<https://api.brandmetrics.com/api/v1/report/detailed/{measurement_id}/benchmark>" -H "Content-Type: application/json" -H "X-API-KEY: {api_key}" -H "Content-Type: application/json" -X GET
The statistics data for a specific report can be accessed by using the endpoint "/api/v1/report/{measurementid}/statistics" and specifying the report's measurementid as a path parameter in the URL.
curl "<https://api.brandmetrics.com/api/v1/report/detailed/{measurement_id}/statistics>" -H "Content-Type: application/json" -H "X-API-KEY: {api_key}" -H "Content-Type: application/json" -X GET
If you would like a list of each individual survey response, you can call the endpoint "/api/v1/report/{measurementid}/surveyresponses" and provide the measurementid of the report as a path parameter in the URL. This will retrieve a list of all the survey responses associated with that report.
curl "<https://api.brandmetrics.com/api/v1/report/detailed/{measurement_id}/surveyresponses>" -H "Content-Type: application/json" -H "X-API-KEY: {api_key}" -H "Content-Type: application/json" -X GET