Get details of a single project

GET

/api/v2/organizations/{organization}/projects/{project}

const url = 'https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project?with_token=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project?with_token=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

organization

required

string

Organization identifier

Example

test-org

project

required

string

Project identifier

Example

test-project

Query Parameters

with_token

required

boolean

Responses

200

The request has succeeded.

application/json

object

required

Project ID

integer

uuid

required

Project UUID

string

name

required

Project name

string

machine_name

required

Project machine name

string

write_token

Write token for API access

string

search_enabled

Whether the project’s search index is enabled. Requires an organisation search subscription.

boolean

search_config

One of:

object

How the project builds and serves its search index. A PATCH merges one section at a time, so sending only extractors leaves algolia untouched; within a section a list replaces wholesale.

object

extractors

XPath expressions that decide what each indexed page contributes to a search record. The defaults take the page body from the meta description, which indexes one sentence per page and matches nothing on body text, so a real deployment should set content to the page’s main content region.

object

title

XPath for the record title

string

default: //h1[1]

content

XPath for the record body

string

default: //meta[@name='description'][1]/@content

summary

XPath for the record summary

string

default: //meta[@name='description'][1]/@content

image

XPath for the record image

string

default: //meta[@property='og:image'][1]/@content

algolia

Index settings. Named algolia for historical reasons; they are applied to whichever backend the project’s platform_mode selects, including Typesense.

object

facets

Fields offered as facets

Array<string>

searchable_attributes

Fields a query matches against

Array<string>

sortable_attributes

Fields results may be sorted by

Array<string>

custom_ranking

Ranking rules, e.g. asc(title)

Array<string>

synonyms

Newline-separated synonym groups, each a comma-separated list of terms

string

Example

{
  "id": 123,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Test Project",
  "machine_name": "test-project",
  "write_token": "abc123token",
  "search_enabled": true,
  "search_config": {
    "extractors": {
      "title": "//h1[1]",
      "content": "//meta[@name='description'][1]/@content",
      "summary": "//meta[@name='description'][1]/@content",
      "image": "//meta[@property='og:image'][1]/@content"
    },
    "algolia": {
      "facets": [
        "content_type",
        "url"
      ],
      "searchable_attributes": [
        "unordered(title)",
        "unordered(summary)",
        "unordered(content)"
      ],
      "sortable_attributes": [],
      "custom_ranking": [
        "asc(title)"
      ],
      "synonyms": "car,automobile\\ndoc,document"
    }
  }
}

400

The server could not understand the request due to invalid syntax.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}

403

Access is forbidden.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}