Run an instance import - bisibility

Error

A valid request URL is required to generate request examples

{
  "counts": {},
  "job_id": "<string>",
  "state": "done"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

POST

/

cloud

/

import

Error

A valid request URL is required to generate request examples

{
  "counts": {},
  "job_id": "<string>",
  "state": "done"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

Authorizations

Authorization

string

header

required

Migration token sent as Authorization: Bearer mig_....

Headers

Bisibility-API-Version

enum<string>

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

Available options:

v1

Body

application/json

alert_rules

object[]

required

Maximum array length: 500

Show child attributes

competitors

object[]

required

Maximum array length: 500

Show child attributes

keywords

object[]

required

Maximum array length: 500

Show child attributes

notification_preferences

object[]

required

Maximum array length: 50

Show child attributes

project_id

string

required

Pattern: ^prj_[a-z][a-z0-9]{23}$

saved_views

object[]

required

Maximum array length: 500

Show child attributes

version

integer

required

exported_at

string<date-time>

scope

enum<string>

Available options:

current,

history

Response

Import completed

counts

object

required

Show child attributes

job_id

string

required

Pattern: ^imp_[a-z][a-z0-9]{23}$

state

enum<string>

required

Available options:

done