Jump to

• Request
• Response

Send a metrics report to this endpoint to be processed by the backend

post

{scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables/{table}/metrics

Request

Path Parameters

• namespace(required): string
  A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override `namespace-separator`, which defaults to the unit separator `0x1F` byte (url encoded `%1F`). To be compatible with older clients, servers must use both the advertised separator and `0x1F` as valid separators when decoding namespaces. The `namespace-separator` should be provided in a url encoded form.

  Examples

  Select an example singlepart_namespace multipart_namespace

• prefix(required): string
  An optional prefix in the path
• table(required): string
  A table name

  Example:

  sales

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• report-type(required): string

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/ScanReport"
        },
        {
            "$ref":"#/components/schemas/CommitReport"
        }
    ],
    "required":[
        "report-type"
    ],
    "properties":{
        "report-type":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

Success, no content

400 Response

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

403 Response

Forbidden. Authenticated user does not have the necessary permissions.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Not Found - NoSuchTableException, table to load does not exist

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example The requested table does not exist

419 Response

This is an optional status response type that the REST Catalog can issue when the token has expired. The client MAY request a new access token and retry the request. 401 UnauthorizedResponse SHOULD be preferred over this response type on token expiry.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

503 Response

The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

5XX Response

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top