FAQ v2

Handle data related to ImBox FAQ and HelpCenter V2.

Get categories

Retrieves all categories

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Query parameters

Name	Type	Description
lang*	String	language of requested resource

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/categories?lang=sv"

Response

[
  {
    "id": 1,
    "userId": 1,
    "createdAt": "2020-02-03T13:00:00.000Z",
    "updatedAt": "2020-02-03T13:00:00.000Z",
    "isRemoved": 0,
    "faqLanguageCode": "",
    "faqCategoryId": 1,
    "title": "",
    "description": ""
  }
]

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Read

Get category

Retrieve one category

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user
id*	Integer	Category id

Query parameters

Name	Type	Description
lang*	String	Language of requested resource
helpCenterId*	Integer	Cannot be used together with faqId
faqId*	Integer	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/categories/:id?lang=sv&faqId=1"

Response

{
  "category": {
    "id": 1,
    "userId": 1,
    "createdAt": "2020-02-03T13:00:00.000Z",
    "updatedAt": "2020-02-03T13:00:00.000Z",
    "isRemoved": 0,
    "faqLanguageCode": "sv",
    "faqCategoryId": 1,
    "title": "",
    "description": ""
  },
  "articleCount": 1,
  // list of all articles under category
  "allArticles": [
    {
      "id": 1,
      "userId": 1,
      "authorId": null,
      "status": "published",
      "publishAt": null,
      "unpublishAt": null,
      "showFeedback": "default",
      "feedbackChatEnabled": 0,
      "feedbackPhoneEnabled": 0,
      "isRemoved": 0,
      "createdAt": "2020-02-03T13:00:00.000Z",
      "updatedAt": "2020-02-03T13:00:00.000Z",
      "faqArticleId": 1,
      "faqLanguageCode": "sv",
      "title": "",
      "content": "",
      "articleFormId": null,
      "feedbackNoFormId": null,
      "feedbackPhoneNumber": null,
      "categoryId": 1,
      "sectionId": 1,
      "order": 1,
      "availableInId": 1,
      "contentPlain": ""
    }
  ],
  // list of articles directly under category
  "orphans": [
    {
      "id": 3,
      "userId": 1,
      "authorId": null,
      "status": "published",
      "publishAt": null,
      "unpublishAt": null,
      "showFeedback": "default",
      "feedbackChatEnabled": 0,
      "feedbackPhoneEnabled": 0,
      "isRemoved": 0,
      "createdAt": "2020-02-03T13:00:00.000Z",
      "updatedAt": "2020-02-03T13:00:00.000Z",
      "faqArticleId": 2,
      "faqLanguageCode": "sv",
      "title": "",
      "content": "",
      "articleFormId": null,
      "feedbackNoFormId": null,
      "feedbackPhoneNumber": null,
      "categoryId": 1,
      "sectionId": null,
      "order": 1,
      "availableInId": 1,
      "contentPlain": ""
    }
  ],
  // list of all sections with their articles
  "sections": [
    {
      "id": 1,
      "userId": 1,
      "faqCategoryId": 1,
      "order": 1,
      "createdAt": "2020-02-03T13:00:00.000Z",
      "updatedAt": "2020-02-03T13:00:00.000Z",
      "title": "",
      "languageCode": "sv",
      "articles": [
        {
          "id": 1,
          "userId": 1,
          "authorId": null,
          "status": "published",
          "publishAt": null,
          "unpublishAt": null,
          "showFeedback": "default",
          "feedbackChatEnabled": 0,
          "feedbackPhoneEnabled": 0,
          "isRemoved": 0,
          "createdAt": "2020-02-03T13:00:00.000Z",
          "updatedAt": "2020-02-03T13:00:00.000Z",
          "faqArticleId": 1,
          "faqLanguageCode": "sv",
          "title": "",
          "content": "",
          "articleFormId": null,
          "feedbackNoFormId": null,
          "feedbackPhoneNumber": null,
          "categoryId": 1,
          "sectionId": 1,
          "order": 1,
          "availableInId": 1,
          "contentPlain": ""
        }
      ]
    }
  ]
}

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Read

Get articles

Retrieve articles with tag

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Query parameters

Name	Type	Description
lang*	String	Language of requested resource
tag*	Array<String>	Tags you want to include
helpCenterId*	Integer	Cannot be used together with faqId
faqId*	Integer	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/articles?tag=imbox&tag=faq"

Response

[
  {
    "id": ,
    "userId": 1,
    "status": "published",
    "publishAt": "2024-03-06T08:00:00.000Z",
    "unpublishAt": null,
    "showFeedback": "default",
    "createdAt": "2024-03-06T07:00:00.000Z",
    "updatedAt": "2024-03-06T07:00:00.000Z",
    "title": "",
    "content": "",
    "faqLanguageCode": "sv",
    "tag": ""
  }
]

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Read

Get article

Retrieve one article

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user
id*	Integer	Article id

Query parameters

Name	Type	Description
lang*	String	Language of requested resource
helpCenterId*	Integer	Cannot be used together with faqId
faqId*	Integer	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/articles/:id?lang=sv&faqId=1"

Response

{
  "id": 1,
  "userId": 1,
  "authorId": null,
  "availableInId": 1,
  "status": "published",
  "publishAt": null,
  "unpublishAt": null,
  "isRemoved": 0,
  "createdAt": "2020-02-03T13:00:00.000Z",
  "updatedAt": "2020-02-03T13:00:00.000Z",
  "faqArticleId": 1,
  "faqLanguageCode": "sv",
  "title": "",
  "content": "",
  "contentPlain": "",
  "feedbackNoFormId": null,
  "articleFormId": null,
  "categoryId": 1,
  "categoryTitle": "",
  "showFeedback": "default",
  "feedbackChatEnabled": 0,
  "feedbackPhoneEnabled": 0,
  "feedbackPhoneNumber": null,
  "authorName": null,
  "authorPicture": null
}

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Read

Search articles

Search for articles

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Query parameters

Name	Type	Description
lang*	String	Language of requested resource
q*	String	Search query
helpCenterId*	Integer	Cannot be used together with faqId
faqId*	Integer	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/search?lang=sv&faqId=1&q=reklamation"

Response

{
  "success": true,
  "articles": [
    {
      "_source": {
        "article_id": 1,
        "content_text": "",
        "id": 1,
        "publish_at": null,
        "status": "published",
        "title": "",
        "unpublish_at": null,
        "user_id": 1,
        "category": [{ "id": 1, "title": "" }],
        "available_in": [
          {
            "id": 1,
            "type": 1
          }
        ]
      },
      "highlight": {
        "title": [""]
      }
    }
  ],
  "length": 3,
  "suggest": [
    {
      "length": 5,
      "offset": 0,
      "options": [
        {
          "score": 0.6717023,
          "text": ""
        }
      ],
      "text": ""
    }
  ]
}

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Read

Search articles suggestions

Retrives articles search suggestions

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Query parameters

Name	Type	Description
lang*	String	Language of requested resource
q*	String	Search query
helpCenterId*	Integer	Cannot be used together with faqId
faqId*	Integer	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/suggest-search?lang=sv&faqId=1&q=reklamation"

Response

{
  "success": true,
  "result": [
    {
      "options": [
        {
          "payload": {
            "id": 1,
            "category": [{ "id": 1, "title": "" }]
          },
          "text": ""
        }
      ],
      "text": ""
    }
  ]
}

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Read

Get popular articles

Retrives all popular articles

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Query parameters

Name	Type	Description
lang*	String	Language of requested resource
helpCenterId*	Integer	Cannot be used together with faqId
faqId*	Integer	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/popular-articles?lang=sv&faqId=1"

Response

[
  {
    "id": 1,
    "userId": 1,
    "authorId": null,
    "availableInId": 1,
    "status": "published",
    "publishAt": null,
    "unpublishAt": null,
    "isRemoved": 0,
    "createdAt": "2020-02-03T13:00:00.000Z",
    "updatedAt": "2020-02-03T13:00:00.000Z",
    "faqArticleId": 1,
    "categoryId": 2,
    "showFeedback": "default",
    "faqLanguageCode": "sv",
    "title": "",
    "content": "",
    "contentPlain": "",
    "feedbackNoFormId": null,
    "articleFormId": null,
    "count": 2,
    "feedbackChatEnabled": 0,
    "feedbackPhoneEnabled": 0,
    "feedbackPhoneNumber": null
  }
]

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Read

Viewed article

Register that the user has seen the article

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Body

Name	Type	Description
lang*	String	Language of viewed resource
articleId*	String	Id of viewed resource
device*	"mobile" | "desktop"	type of device that has viewed resource
helpCenterId*	Integer	Cannot be used togheter with faqId
faqId*	Integer	Cannot be used togheter with helpcenterId

Usage

curl -X POST -H "Content-Type: application/json" -d @viewed.json "https://apiv2.imbox.io/api/:apiKey/:userId/faq/analytics/views"

viewed.json

{
  "lang": "sv",
  "articleId": "1",
  "device": "desktop",
  "helpCenterId": "423"
}

Response

204

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Write

Vote yes

Register positive response to article

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Body

Name	Type	Description
lang*	String	Language of viewed resource
articleId*	String	Id of viewed resource
device*	"mobile" | "desktop"	Type of device that has viewd resource
helpCenterId*	Integer	Cannot be used togheter with faqId
faqId*	Integer	Cannot be used togheter with helpcenterId

Usage

curl -X POST -H "Content-Type: application/json" -d @vote.json "https://apiv2.imbox.io/api/:apiKey/:userId/faq/analytics/voteyes"

vote.json

{
  "lang": "sv",
  "articleId": "1",
  "device": "desktop",
  "helpCenterId": "423"
}

Response

204

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Write

Vote no

Register negative response to article

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	Integer	Unique id for the user

Body

Name	Type	Description
lang*	String	Language of viewed resource
articleId*	String	Id of viewed resource
device*	"mobile" | "desktop"	Type of device that has viewd resource
helpCenterId*	Integer	Cannot be used togheter with faqId
faqId*	Integer	Cannot be used togheter with helpcenterId

Usage

curl -X POST -H "Content-Type: application/json" -d @vote.json "https://apiv2.imbox.io/api/:apiKey/:userId/faq/analytics/voteno"

vote.json

{
  "lang": "sv",
  "articleId": "1",
  "device": "desktop",
  "helpCenterId": "423"
}

Response

204

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
FAQ	Write