Searches for a phrase inside project version

Prev Next
Get
/v2/ProjectVersions/{projectVersionId}/{langCode}
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters
projectVersionId
stringRequired

The ID of the project version

langCode
stringRequired

The language code of the article

Default"en"
Query parameters
searchQuery
string

The phrase to search across all articles in the project version

page
integer (int32)

Specify the page to retrieve. Page numbers are zero-based. Therefore, to retrieve the 10th page, you need to set page=9

Default0
hitsPerPage
integer (int32)

Number of results per page

Default10
Responses
200

Success

Example for 200 response

200 response in searches for a phrase inside project version

{
  "data": {
    "hits": [
      {
        "title": "Understanding Home page builder",
        "content": "The home page is the first page an end-user will see when they visit your knowledge base. The Home Page Builder lets you customize your home page by adding links, changing colors, including categories from your knowledge base, and more. \n The home page builder comes with an intuitive interface to design a professional looking front-page to your knowledge base. You do not need any developer support to create a good looking home page. \n If you do not want a home page and would like to direct the user directly to the real content, you can easily turn off the home page for your knowledge base. \n \n                \n                This is a sample article, you can safely delete it. \n  \n",
        "is_hidden": false,
        "tags": [],
        "slug": "understanding-home-page-builder",
        "version": 1,
        "article_id": "6116080f-5b38-4037-b878-82d318543dsw",
        "category_id": "6116080f-5b38-4037-b878-82d318543af",
        "is_category_hidden": null,
        "order": 5,
        "is_draft": false,
        "exclude": false,
        "breadcrumb": null,
        "is_category": null,
        "attachment_ids": null,
        "is_deleted": null,
        "is_folder_type_category": null,
        "updated_on_timestamp": null,
        "is_private": false,
        "language_id": null,
        "project_id": null,
        "is_latest_version": null,
        "contributors": null,
        "is_shared_article": null,
        "lang_code": null,
        "category_unique_id": null,
        "unique_id": null,
        "deleted_by": null,
        "deleted_at": null,
        "is_git_hub_entity": false,
        "original_article_id": null,
        "object_id": "",
        "_snippet_result": {
          "content": {
            "value": " The home page is the first page an end-user will see when they visit your knowledge base. The Home Page Builder lets you customize your home page by adding links, changing colors, including categories from your knowledge base, and more. \n The home page builder comes with an intuitive",
            "match_level": ""
          }
        },
        "_highlight_result": {
          "title": null
        }
      }
    ],
    "nb_hits": null,
    "page": null,
    "nb_pages": null,
    "hits_per_page": null,
    "processing_time_ms": null,
    "query": null
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
object | null
hits
Array of object (Hit) | null

The list of articles that matched the search query.

object
title
string | null

Article title

content
string | null

Article HTML content

is_hidden
boolean | null

Indicates if the article is visible on the site

tags
Array of string | null

Custom article tags

string
slug
string | null

The slug of the article

version
integer (int32) | null

The version number that is currently published

article_id
string | null

The ID of the article

category_id
string | null

The ID of the category

is_category_hidden
boolean | null

Indicates if category is visible on the site

order
integer (int32)

The position inside the parent category

is_draft
boolean | null

Indicates if the article is marked as a draft

exclude
boolean | null

Indicates if the article is excluded from search results on user website

breadcrumb
string | null

The breadcrumb of the article

is_category
boolean | null

If the value is True, then the object has to considered as a category, otherwise it is an article

attachment_ids
Array

The IDs of the files attached to the article

is_deleted
boolean | null

If the value is True, then it indicates that the article has been deleted

is_folder_type_category
boolean | null

If the value is True, then it indicates that the category is a folder type category

updated_on_timestamp
number (double) | null

The last updated timestamp of the article

is_private
boolean

If the value is True, then the article can only be accessed by logged in users in the knowledge base site

language_id
string | null

The ID of the language

project_id
string | null

The ID of the project

is_latest_version
boolean | null

If the value is True, then the article is the latest version

contributors
Array of string | null

The IDs of users who have contributed to the article

string
is_shared_article
integer (int32) | null

If the value is True, then it indicates that it is a shared article

lang_code
string | null

The language code of the article or category

category_unique_id
string | null

A unique identifier for the category which is a combination of category ID and the language code

unique_id
string | null

A unique identifier for the article which is a combination of article ID and the language code

deleted_by
string | null

The ID of the user who deleted the article

deleted_at
string | null

The timestamp when the article was deleted

is_git_hub_entity
boolean

If the value is True, then it indicates that the article is synced from GitHub

original_article_id
string | null

The original article ID. Applicable only for shared articles.

object_id
string | null

algolia search object ID

_snippet_result
object | null

Markup text with occurrences highlighted.

content
object | null
value
string | null

Markup text with occurrences highlighted.

match_level
string | null

Indicates how well the attribute matched the search query. Can be: none, partial, full

_highlight_result
object | null

Highlighted attributes

title
object | null
value
string | null

Markup text with occurrences highlighted.

match_level
string | null

Indicates how well the attribute matched the search query. Can be: none, partial, full

fully_highlighted
boolean
matched_words
Array of string | null

List of words from the query that matched the object.

string
nb_hits
integer (int32) | null

The number of hits (articles) matched by the query.

page
integer (int32) | null

The position of the current page (zero-based).

nb_pages
integer (int32) | null

The number of returned pages. Calculation is based on the total number of hits (nbHits) divided by the number of hits per page (hitsPerPage), rounded up to the nearest integer.

hits_per_page
integer (int32) | null

Maximum number of hits (articles) per page.

processing_time_ms
integer (int32) | null

The time the server took to process the request, in milliseconds. This doesn’t include network time.

query
string | null

The query used to search the articles.

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information

400

Bad Request

Example for 400 response due to project version Id

400 bad response due to invalid Project version Id

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The supplied project version id does not exist in your project",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Example for 400 response due to Lanuage Code

400 bad response due to invalid Language Code

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Invalid Language code",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information