@akamai/openapi-ts
    Preparing search index...

    Type Alias PostReadMetricData

    type PostReadMetricData = {
        body:
            | {
                entity_ids: number[];
                filters?: {
                    dimension_label?: string;
                    operator?: "eq"
                    | "neq"
                    | "startswith"
                    | "endswith";
                    value?: string;
                }[];
                group_by?: string[];
                metrics: {
                    aggregate_function?: "min"
                    | "max"
                    | "avg"
                    | "sum";
                    name?: string;
                }[];
                time_granularity?: {
                    unit?: "sec"
                    | "min"
                    | "hr"
                    | "days";
                    value?: number;
                };
            } & {
                relative_time_duration: {
                    unit?: "sec"
                    | "min"
                    | "hr"
                    | "days";
                    value?: number;
                };
            }
            | {
                entity_ids: number[];
                filters?: {
                    dimension_label?: string;
                    operator?: "eq"
                    | "neq"
                    | "startswith"
                    | "endswith";
                    value?: string;
                }[];
                group_by?: string[];
                metrics: {
                    aggregate_function?: "min"
                    | "max"
                    | "avg"
                    | "sum";
                    name?: string;
                }[];
                time_granularity?: {
                    unit?: "sec"
                    | "min"
                    | "hr"
                    | "days";
                    value?: number;
                };
            } & { absolute_time_duration: { end?: string; start?: string } };
        path: { serviceType: string };
        query?: never;
        url: "monitor/services/{serviceType}/metrics";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body:
        | {
            entity_ids: number[];
            filters?: {
                dimension_label?: string;
                operator?: "eq"
                | "neq"
                | "startswith"
                | "endswith";
                value?: string;
            }[];
            group_by?: string[];
            metrics: {
                aggregate_function?: "min"
                | "max"
                | "avg"
                | "sum";
                name?: string;
            }[];
            time_granularity?: {
                unit?: "sec"
                | "min"
                | "hr"
                | "days";
                value?: number;
            };
        } & {
            relative_time_duration: {
                unit?: "sec"
                | "min"
                | "hr"
                | "days";
                value?: number;
            };
        }
        | {
            entity_ids: number[];
            filters?: {
                dimension_label?: string;
                operator?: "eq"
                | "neq"
                | "startswith"
                | "endswith";
                value?: string;
            }[];
            group_by?: string[];
            metrics: {
                aggregate_function?: "min"
                | "max"
                | "avg"
                | "sum";
                name?: string;
            }[];
            time_granularity?: {
                unit?: "sec"
                | "min"
                | "hr"
                | "days";
                value?: number;
            };
        } & { absolute_time_duration: { end?: string; start?: string } }

    Settings used for data queries.

    Type Declaration

    • {
          entity_ids: number[];
          filters?: {
              dimension_label?: string;
              operator?: "eq" | "neq" | "startswith" | "endswith";
              value?: string;
          }[];
          group_by?: string[];
          metrics: {
              aggregate_function?: "min"
              | "max"
              | "avg"
              | "sum";
              name?: string;
          }[];
          time_granularity?: { unit?: "sec"
          | "min"
          | "hr"
          | "days"; value?: number };
      } & {
          relative_time_duration: {
              unit?: "sec"
              | "min"
              | "hr"
              | "days";
              value?: number;
          };
      }
      • entity_ids: number[]

        The id for each individual entity from a service_type. Get this value by running the list operation for the appropriate entity. For example, if your entity is one of your PostgreSQL databases, run the List PostgreSQL Managed Databases operation and store the id for the appropriate database from the response.

      • Optionalfilters?: {
            dimension_label?: string;
            operator?: "eq" | "neq" | "startswith" | "endswith";
            value?: string;
        }[]

        Individual objects that define dimension filters for the query.

      • Optionalgroup_by?: string[]

        Categorizes response data based on the specified fields:

        • entity_id. Include this parameter by name to group the response data using the entity_id values included in the request.

        • dimension_label. This represents the desired dimension from a monitoring metric. To get a dimension_label, run the List metrics for a service type operation, review the available dimensions, and store the applicable dimension_label values.

        You can group these fields using these combinations:

        • Group by entity_id values and one or more dimensions_label values. For example, [entity_id, node_type] groups response data based on values set for the entity_id parameter and the node_type dimension that's available for a service_type of dbaas.

        • Group by only the entity_id values. For example, [entity_id] exclusively groups response data based on values set for the entity_id parameter.

        • Group by one or more dimension_label values. For example, [node_type] groups response data based on the node_type dimension that's available for a service_type of dbaas.

        If you leave this out of a request, data is aggregated across all series.

      • metrics: { aggregate_function?: "min" | "max" | "avg" | "sum"; name?: string }[]

        A list of metric objects, each specifying a metric name and its corresponding aggregation function.

      • Optionaltime_granularity?: { unit?: "sec" | "min" | "hr" | "days"; value?: number }

        Allows for an optional time granularity setting for metric data.

        • Optionalunit?: "sec" | "min" | "hr" | "days"

          The unit of time granularity for the metric data. Available values are sec, min, hr, and days.

        • Optionalvalue?: number

          The value that corresponds to the unit. Set to 10 with a unit of hr for 10 hours.

      • relative_time_duration: { unit?: "sec" | "min" | "hr" | "days"; value?: number }

        Specifies a relative time duration for data queries. Queries begin immediately for the specified amount of time. You can specify a relative_time_duration or an absolute_time_duration, but not both.

        • Optionalunit?: "sec" | "min" | "hr" | "days"

          The unit of time used for the relative duration to query metric data. Available values are sec, min, hr, and days.

        • Optionalvalue?: number

          The value that corresponds to the unit. Set to 30 with a unit of min for 30 minutes.

    • {
          entity_ids: number[];
          filters?: {
              dimension_label?: string;
              operator?: "eq" | "neq" | "startswith" | "endswith";
              value?: string;
          }[];
          group_by?: string[];
          metrics: {
              aggregate_function?: "min"
              | "max"
              | "avg"
              | "sum";
              name?: string;
          }[];
          time_granularity?: { unit?: "sec"
          | "min"
          | "hr"
          | "days"; value?: number };
      } & { absolute_time_duration: { end?: string; start?: string } }
      • entity_ids: number[]

        The id for each individual entity from a service_type. Get this value by running the list operation for the appropriate entity. For example, if your entity is one of your PostgreSQL databases, run the List PostgreSQL Managed Databases operation and store the id for the appropriate database from the response.

      • Optionalfilters?: {
            dimension_label?: string;
            operator?: "eq" | "neq" | "startswith" | "endswith";
            value?: string;
        }[]

        Individual objects that define dimension filters for the query.

      • Optionalgroup_by?: string[]

        Categorizes response data based on the specified fields:

        • entity_id. Include this parameter by name to group the response data using the entity_id values included in the request.

        • dimension_label. This represents the desired dimension from a monitoring metric. To get a dimension_label, run the List metrics for a service type operation, review the available dimensions, and store the applicable dimension_label values.

        You can group these fields using these combinations:

        • Group by entity_id values and one or more dimensions_label values. For example, [entity_id, node_type] groups response data based on values set for the entity_id parameter and the node_type dimension that's available for a service_type of dbaas.

        • Group by only the entity_id values. For example, [entity_id] exclusively groups response data based on values set for the entity_id parameter.

        • Group by one or more dimension_label values. For example, [node_type] groups response data based on the node_type dimension that's available for a service_type of dbaas.

        If you leave this out of a request, data is aggregated across all series.

      • metrics: { aggregate_function?: "min" | "max" | "avg" | "sum"; name?: string }[]

        A list of metric objects, each specifying a metric name and its corresponding aggregation function.

      • Optionaltime_granularity?: { unit?: "sec" | "min" | "hr" | "days"; value?: number }

        Allows for an optional time granularity setting for metric data.

        • Optionalunit?: "sec" | "min" | "hr" | "days"

          The unit of time granularity for the metric data. Available values are sec, min, hr, and days.

        • Optionalvalue?: number

          The value that corresponds to the unit. Set to 10 with a unit of hr for 10 hours.

      • absolute_time_duration: { end?: string; start?: string }

        Specifies an absolute time range for data queries. Queries begin and end at a specific time.

        📘

        • You can query data for up to 31 days.

        • You can specify a relative_time_duration or an absolute_time_duration, but not both.

        • Optionalend?: string

          The end time for querying data, in ISO 8601 format, using the UTC time zone.

        • Optionalstart?: string

          The start time for querying data, in ISO 8601 format, using the UTC time zone.

    path: { serviceType: string }

    Type Declaration

    • serviceType: string

      The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate service_type.

    query?: never
    url: "monitor/services/{serviceType}/metrics"

    Settings

    Member Visibility

    On This Page

    Properties