Ingest event data

post

https://api.toqua.ai/ships/{imo_number}/data/events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

imo_number

string

required

Body Params

type

array of strings

required

length ≤ 3000

List of event types

Event type*

description

array | null

List of event descriptions

datetime_start

array | null

List of datetimes on which the events start. Datetime must be in ISO8601 format, and must specify a timezone.

datetime_end

array | null

List of datetimes on which the events end. Datetime must be in ISO8601 format, and must specify a timezone.

expected_performance_change

array | null

List of expected increases or decreases in performance after an event, in percent (%) between -100 and 100. A value of -100 means 100% extra power is required to achieve the same speed.

paint_type

array | null

The type of paint that was applied

type_of_fouling

array | null

Qualitative measure of the type of fouling that was present before the cleaning

price

array | null

Price of the cleaning in US$

service_provider

array | null

Name of the company who did the cleaning

Headers

x-toqua-channel

Override ingestion channel (pull, email, push, manual, unknown).

x-toqua-source-system

Override source system identifier.

Responses

501

Not Implemented

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201OK

422Validation Error