Interface ApiLogDetail

interface ApiLogDetail {
    began: string;
    body?: string;
    duration_ns?: string;
    impersonator?: string;
    method: ApiLogDetailMethod;
    params?: string;
    path: string;
    status_code?: number;
}

Properties

began body? duration_ns? impersonator? method params? path status_code?

Properties

began

began: string

The date/time the API call began

Optionalbody

body?: string

A JSON string representing the in-body properties used in the call

Optionalduration_ns

duration_ns?: string

The REST method approximate execution time (nS) in a humanised form, where 7969400 is presented as 7,969,400

Optionalimpersonator

impersonator?: string

Not all API calls using your user ID may have been executed by you, In cases where an administrator has executed a REST API call on your behalf, their user ID will be revealed using this property

method

method: ApiLogDetailMethod

The REST method used. GET methods are not logged

Optionalparams

params?: string

A JSON string representing the in-query properties used in the call

path

path: string

The API path used, e.g. /dataset

Optionalstatus_code

status_code?: number

The HTTP response status code

Settings

Member Visibility

On This Page

Properties