List All Video Responses

This endpoint allows you to retrieve all video responses for a specific FacePop.

Endpoint Details

Request

GET /facepop/response/video/all

This endpoint requires a GET request with your API key and a facepopId parameter.

Parameters

Required Parameters:

APIKey

Your unique API key to authenticate the request.

facepopId

A string containing the ID of the FacePop you want to retrieve video responses for.

Note: Both parameters must be included in the request for successful retrieval of video responses.

Response

Status: 200 OK

The endpoint always returns a 200 OK status code with a JSON response.

Success Response Body:

{
  "status": true,
  "data": [
    {
      "id": "response_id_1",
      // Video response object 1
    },
    {
      "id": "response_id_2",
      // Video response object 2
    }
    // Additional video response objects
  ]
}

Error Response:

{
  "status": false,
  "data": "This FacePop was not found in your account"
}

Various error messages may be returned based on the specific issue encountered.

Example Request

Using cURL:

curl -X GET "https://api.answerly.io/facepop/response/video/all?APIKey=your_api_key_here&facepopId=your_facepop_id_here"

Important Notes

Response Structure

The response data field contains an array of video response objects. Each object represents a single video response submitted to your FacePop. If no responses are found, an empty array will be returned.

Authentication

This endpoint requires the same APIKey authentication as other FacePop endpoints. Ensure your API key is valid and has the necessary permissions to access the requested FacePop.

Error Handling

Always check the status field in the response to confirm if the operation succeeded. If the status is false, the data field will contain an error message explaining what went wrong.

Documentation Menu