Management API

Displays API

The Public Client API is designed for the JavaScript SDK and does not require authentication. It's primarily used for creating persons, sessions, and responses within the Formbricks platform. This API is ideal for client-side interactions, as it doesn't expose sensitive information.


POST/api/v1/client/diplays

Mark Survey as Displayed for Person

Mark a Survey as seen for a Person provided valid SurveyId and PersonId.

Mandatory Request Body JSON Keys

  • Name
    surveyId
    Type
    string
    Description

    Survey ID to mark as viewed for a person

  • Name
    personId
    Type
    string
    Description

    Person ID for whom mark a survey as viewed

Request

POST
/api/v1/displays
curl -X POST \
'https://app.formbricks.com/api/v1/client/displays' \
-H 'Content-Type: application/json' \
-d '{
    "surveyId": "<survey-id>",
    "personId": "<person-id>"
}'

Response

{
  "data": {
    "id": "clm4qiygr00uqs60h5f5ola5h",
    "createdAt": "2023-09-04T10:24:36.603Z",
    "updatedAt": "2023-09-04T10:24:36.603Z",
    "surveyId": "<survey-id>",
    "person": {
        "id": "<person-id>",
        "attributes": {
            "userId": "CYO600",
            "email": "wei@google.com",
            "Name": "Wei Zhu",
            "Role": "Manager",
            "Company": "Google",
            "Experience": "2 years",
            "Usage Frequency": "Daily",
            "Company Size": "2401 employees",
            "Product Satisfaction Score": "4",
            "Recommendation Likelihood": "3"
            },
        "createdAt": "2023-08-08T18:05:01.483Z",
        "updatedAt": "2023-08-08T18:05:01.483Z"
        },
    "status": "seen"
    }
}

POST/api/v1/client/diplays/[displayId]/responded

Mark Survey as Responded for Person

Mark a Displayed Survey as responded for a Person.

Request

POST
/api/v1/client/diplays/[displayId]/responded
curl -X POST \
--location \
'https://app.formbricks.com/api/v1/client/displays/<displayId>/responded'

Response

{
  "data": {
    "id": "<displayId>",
    "createdAt": "2023-09-04T10:24:36.603Z",
    "updatedAt": "2023-09-04T10:33:56.978Z",
    "surveyId": "<surveyId>",
    "person": {
        "id": "<personId>",
        "attributes": {
            "userId": "CYO600",
            "email": "wei@google.com",
            "Name": "Wei Zhu",
            "Role": "Manager",
            "Company": "Google",
            "Experience": "2 years",
            "Usage Frequency": "Daily",
            "Company Size": "2401 employees",
            "Product Satisfaction Score": "4",
            "Recommendation Likelihood": "3"
        },
        "createdAt": "2023-08-08T18:05:01.483Z",
        "updatedAt": "2023-08-08T18:05:01.483Z"
    },
    "status": "responded"
  }
}

Was this page helpful?