FAQ v2

Get categories

Retrieves all categories

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId
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": ""
  }
]

Get category

Retrieve one category

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId
lang*	string	language of requested resource
id*	number	id of resource
helpCenterId*	number	Cannot be used together with faqId
faqId*	number	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/categories/:id"

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": ""
        }
      ]
    }
  ]
}

Get articles

Retrieve articles with tag

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId
lang*	string	language of requested resource
tag*	string	tags you want to include
helpCenterId*	number	Cannot be used together with faqId
faqId*	number	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": ""
  }
]

Get article

Retrieve one article

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId
lang*	string	language of requested resource
id*	number	id of resource
helpCenterId*	number	Cannot be used together with faqId
faqId*	number	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/articles/:id"

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
}

Search articles

Search for articles

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId
lang*	string	language of requested resource
q*	string	search query
helpCenterId*	number	Cannot be used together with faqId
faqId*	number	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/search"

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": ""
    }
  ]
}

Search articles suggestions

Retrives articles search suggestions

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId
lang*	string	language of requested resource
q*	string	search query
helpCenterId*	number	Cannot be used together with faqId
faqId*	number	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/suggest-search"

Response

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

Get popular articles

Retrives all popular articles

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId
lang*	string	language of requested resource
helpCenterId*	number	Cannot be used together with faqId
faqId*	number	Cannot be used together with helpCenterId

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/faq/popular-articles"

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
  }
]

Viewed article

Register that the user has seen the article

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId

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*	number	cannot be used togheter with faqId
faqId*	number	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

Vote yes

Register positive response to article

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId

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*	number	cannot be used togheter with faqId
faqId*	number	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

Vote no

Register negative response to article

Parameters

name	Type	Description
apiKey*	string	Your API Key
userId*	number	Your userId

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*	number	cannot be used togheter with faqId
faqId*	number	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