Get a site's import report

For a site made from a client's current website: every page made or left out (the package's page limit), every picture added (its library address and real size) or left out with the reason, pages that couldn't be read, and the details found.

GET/api/v1/sites/{site_id}/import

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the sites:read scope — read sites, pages and sections.

sites:readRead onlyMCP tool: get_site_import

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required: The site's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/import' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "site_id": "SITE_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "source": {
      "type": "string"
    },
    "site_title": {
      "type": "string"
    },
    "imported_at": {
      "type": "string"
    },
    "template": {
      "type": "string"
    },
    "design": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "source_url": {
            "type": "string"
          },
          "made": {
            "type": "boolean"
          },
          "sections": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "pictures": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "shortened": {
            "type": "boolean"
          }
        },
        "required": [
          "title",
          "slug",
          "source_url",
          "made",
          "sections",
          "pictures",
          "shortened"
        ],
        "additionalProperties": false
      }
    },
    "pictures": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "source_url": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "added",
              "skipped"
            ]
          },
          "reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "width": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "height": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "bytes": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "source_url",
          "status",
          "reason",
          "url",
          "width",
          "height",
          "bytes"
        ],
        "additionalProperties": false
      }
    },
    "skipped_pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        },
        "required": [
          "url",
          "reason"
        ],
        "additionalProperties": false
      }
    },
    "found": {
      "type": "object",
      "properties": {
        "phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "logo": {
          "type": "boolean"
        },
        "contact_form": {
          "type": "boolean"
        }
      },
      "required": [
        "phone",
        "email",
        "logo"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "source",
    "site_title",
    "imported_at",
    "template",
    "design",
    "pages",
    "pictures",
    "skipped_pages",
    "found"
  ],
  "additionalProperties": false
}