Jump to

• Request
• Response
• Examples

Get All InApp business Metrics

get

/rest/v19/metrics

This operation returns all the InApp business metrics to monitor daily.

Request

Query Parameters

• excludeLinks: string
  Exclude links.
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

InApp business metrics daily data.

Body ()

Root Schema : Daily Metrics

Type: object

Title: Daily Metrics

Metrics collection reports.

Show Source

• count: integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore: boolean
  Title: hasMore

  Returns true if more resources are available on the server than the subset returned in current page.
• items: array This is list of all metrics contents
  Title: This is list of all metrics contents

  Metrics reports.
• limit: integer
  Title: Limit

  The actual paging size used by the server.
• links: array Metrics Links
  Title: Metrics Links

  Links for the Metrics
• offset: integer
  Title: Offset

  The offset used in the current page.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Metrics reports.",
            "title":"This is list of all metrics contents",
            "items":{
                "$ref":"#/definitions/metricsContent"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page.",
            "title":"Offset"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page.",
            "title":"hasMore"
        },
        "links":{
            "type":"array",
            "description":"Links for the Metrics",
            "title":"Metrics Links",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "title":"Daily Metrics",
    "description":"Metrics collection reports."
}

Nested Schema : This is list of all metrics contents

Type: array

Title: This is list of all metrics contents

Metrics reports.

Show Source

• Array of: object metricsContent

{
    "type":"array",
    "description":"Metrics reports.",
    "title":"This is list of all metrics contents",
    "items":{
        "$ref":"#/definitions/metricsContent"
    }
}

Nested Schema : Metrics Links

Type: array

Title: Metrics Links

Links for the Metrics

Show Source

• Array of: object referenceLinks
  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links for the Metrics",
    "title":"Metrics Links",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested Schema : metricsContent

Type: object

Show Source

• dateAdded: string
  Title: Date Added

  Metric creation date.
• dateModified: string
  Title: Date Modified

  Metric modified date.
• endTime: string
  Title: End Time

  Metrics reports collection end time in UTC.
• metricsId: string
  Title: metricsId

  Unique ID for each instance of your app.
• name: string
  Title: Name

  Name of the metric.
• startTime: string
  Title: Start Time

  Metrics reports collection start time in UTC.
• value: string
  Title: Value

  Metric value.

{
    "type":"object",
    "properties":{
        "metricsId":{
            "type":"string",
            "description":"Unique ID for each instance of your app.",
            "title":"metricsId"
        },
        "name":{
            "type":"string",
            "description":"Name of the metric.",
            "title":"Name"
        },
        "value":{
            "type":"string",
            "description":"Metric value.",
            "title":"Value"
        },
        "startTime":{
            "type":"string",
            "description":"Metrics reports collection start time in UTC.",
            "title":"Start Time"
        },
        "endTime":{
            "type":"string",
            "description":"Metrics reports collection end time in UTC.",
            "title":"End Time"
        },
        "dateAdded":{
            "type":"string",
            "description":"Metric creation date.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"Metric modified date.",
            "title":"Date Modified"
        }
    }
}

Nested Schema : referenceLinks

Type: object

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example returns the daily business metrics by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/metrics

Response Body Sample

[
  {
    "name": "QUOTES",
    "value": "0",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "INTERNALQUOTES",
    "value": "0",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "PARTNERQUOTES",
    "value": "0",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "INTERNALUSERS",
    "value": "156",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "REMAININGINTERNALLICENSES",
    "value": "356",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "INTERNALUSERSLOGGEDIN",
    "value": "1",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "PERCENTINTERNALUSERSLOGGEDIN",
    "value": "0.64102566",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "PARTNERUSERS",
    "value": "141",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "PARTNERUSERSLOGGEDIN",
    "value": "0",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "PERCENTPARTNERUSERSLOGGEDIN",
    "value": "0.0",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "ECOMMERCEINTERACTIONS",
    "value": "0",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "APILICENSES",
    "value": "0",
    "startTime": "2024-05-06T00:00:00+0000",
    "endTime": "2024-05-06T23:59:59+0000"
  }, {
    "name": "DISKSPACE",
    "value": "0.015850715",
    "startTime": "2024-05-07T07:37:06+0000",
    "endTime": "2024-05-07T07:37:06+0000"
  }
]

Back to Top