Commerce Insights SSO API

Overview

The Commerce Insights SSO service provides access to Commerce Insights reports using REST calls. You can use these APIs to generate URLs for Commerce Insights reports.

Reports include:

  • Dashboard
  • Realtime
  • Insights
  • Merchandising
  • Marketing
  • Customer summaries
  • Orders

See also

API Reference

/site/{partner_site_id}/{report}

Retrieves the iFrame-able URL to a Commerce Insights report

/site/{partner_site_id}/{report}

get

Retrieves the URL

Scopes required: hybris.comminsights-sso_view

Retrieves the URL

Scopes required: hybris.comminsights-sso_view

URI Parameters

  • partner_site_id: required (string)
  • report: required (one of dashboard, realtime, insights, merchandising, marketing, orders, customer-summary)

Headers

  • Authorization: required (string)

    Used to send a valid OAuth2 access token.

    Example:

    Bearer access_token

HTTP status code 200

Body

Type: application/json

Schema:

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  }
}

Example:

{"url": "https://example.com/board/?signed_payload=XXXXXXXXXXXXXX#dashboard"}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "title":"error",
  "description":"Schema for API specified errors.",
  "type":"object",
  "properties":
  {
    "status":
    {
      "type":"integer",
      "description":"original HTTP error code, should be consistent with the response HTTP code",
      "minimum":100,
      "maximum":599
    },
    "type":
    {
      "type":"string",
      "description":"classification of the error type, lower case with underscore eg validation_failure",
      "pattern":"[a-z]+[a-z_]*[a-z]+"
    },
    "message":
    {
      "type":"string",
      "description":"descriptive error message for debugging"
    },
    "moreInfo":
    {
      "type":"string",
      "format":"uri",
      "description":"link to documentation to investigate further and finding support"
    },
    "details":
    {
      "type":"array",
      "description":"list of problems causing this error",
      "items":
      {
        "$schema":"http://json-schema.org/draft-04/schema#",
        "title":"errorDetail",
        "description":"schema for specific error cause",
        "type":"object",
        "properties":
        {
          "field":
          {
            "type":"string",
            "description":"a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
          },
          "type":
          {
            "type":"string",
            "description":"classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
            "pattern":"[a-z]+[a-z_]*[a-z]+"
          },
          "message":
          {
            "type":"string",
            "description":"descriptive error detail message for debugging"
          },
          "moreInfo":
          {
            "type":"string",
            "format":"uri",
            "description":"link to documentation to investigate further and finding support for error detail"
          }
        },
        "required":["type"]
      }
    }
  },
  "required":["status" , "type" ]
}

Example:

{
  "status":401,
  "message":"Authorization: Unauthorized. Bearer TOKEN is invalid",
  "type":"insufficient_credentials",
  "moreInfo":"https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "title":"error",
  "description":"Schema for API specified errors.",
  "type":"object",
  "properties":
  {
    "status":
    {
      "type":"integer",
      "description":"original HTTP error code, should be consistent with the response HTTP code",
      "minimum":100,
      "maximum":599
    },
    "type":
    {
      "type":"string",
      "description":"classification of the error type, lower case with underscore eg validation_failure",
      "pattern":"[a-z]+[a-z_]*[a-z]+"
    },
    "message":
    {
      "type":"string",
      "description":"descriptive error message for debugging"
    },
    "moreInfo":
    {
      "type":"string",
      "format":"uri",
      "description":"link to documentation to investigate further and finding support"
    },
    "details":
    {
      "type":"array",
      "description":"list of problems causing this error",
      "items":
      {
        "$schema":"http://json-schema.org/draft-04/schema#",
        "title":"errorDetail",
        "description":"schema for specific error cause",
        "type":"object",
        "properties":
        {
          "field":
          {
            "type":"string",
            "description":"a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
          },
          "type":
          {
            "type":"string",
            "description":"classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
            "pattern":"[a-z]+[a-z_]*[a-z]+"
          },
          "message":
          {
            "type":"string",
            "description":"descriptive error detail message for debugging"
          },
          "moreInfo":
          {
            "type":"string",
            "format":"uri",
            "description":"link to documentation to investigate further and finding support for error detail"
          }
        },
        "required":["type"]
      }
    }
  },
  "required":["status" , "type" ]
}

Example:

{
  "status": 403,
  "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
  "type": "insufficient_permissions"
}

HTTP status code 404

Bad Request

Body

Type: application/json

Scopes

Scopes are strings that let you specify exactly what type of access you need to resources and operations in the Commerce Insights SSO service.

You must provide a proper scope that allows users to perform certain operations. Grant the scopes in an access token from the OAuth 2.0 service. For more information about the authorization and authentication used in SAP Hybris services, and also about the scopes in general, see:

The table presents all the scopes that the Commerce Insights SSO service supports.
ScopeDescription
hybris.comminsights-sso_viewUse this scope to see the Commerce Insights reports.

iframe Example

Here is an example of rendering the Commerce Insights report using iframe. With YOUR_REPORT_URL returned from a successful call to the Commerce Insights SSO API, follow these steps:

  1. Create an iframe.

    <iframe name="theFrame"></iframe>

  2. Open YOUR_REPORT_URL in iframe:

    window.open(YOUR_REPORT_URL, "theFrame");

  • Send feedback

    If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.

  • Get Help

    Use our private help channel. Receive updates over email and contact our specialists directly.

  • hybris Experts

    If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.