Create import upload REST API

POST

/api/sites/{id}/imports/{provider}/uploads

curl --request POST \
  --url https://app.hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/imports/plausible/uploads \
  --header 'Content-Type: application/json' \
  --cookie hk_token=<hk_token> \
  --data '{ "files": [ { "filename": "example", "sha256": "example", "size_bytes": 1 } ] }'

Creates a staged import upload session. Use chunk upload endpoints to send the declared ZIP or CSV files.

Authorizations

• cookieAuth
• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

provider

required

string

Allowed values: plausible simpleanalytics

Request Body^required

Media typeapplication/json

object

files

required

Array<object>

object

filename

required

string

sha256

Optional lowercase or uppercase hex SHA-256 checksum for the staged file.

string

size_bytes

required

integer

Example^generated

{
  "files": [
    {
      "filename": "example",
      "sha256": "example",
      "size_bytes": 1
    }
  ]
}

Responses

200

Upload session

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

400

Invalid upload

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

413

Import exceeds maximum staged size

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}