Discovery Apps (v1)

Endpoint URL

POST https://api-prod-eu-central-1.inappnavi.com/api/public/v1/{{tenantId}}/discovery/discoveryApps 

Purpose

Retrieves a list of discovered applications for the specified time period, including usage metrics and other data displayed in the AppNavi UI.

Request Structure

When making a POST request to /discoveryApps ,include the authentication token in the header and include the following JSON body. Below is a common example; parameter names or structures may differ based on your final OpenAPI documentation:

QueryParams Parameters:

Description of Fields

This table provides a detailed overview of all application fields, including their technical (API) names, data types, corresponding UI labels, descriptions and data sources. It helps map backend data structures to the user interface and clarifies whether each field is automatically populated or manually maintained.

SaaS Catalog Data Inheritance

This table presents the relationship between applications and the SaaS catalog by indicating which fields are automatically inherited and which are maintained manually. Applications recognized in the SaaS catalog benefit from predefined metadata, ensuring consistency and reducing manual effort, while non-catalog applications require user-defined inputs.

Example: Calling via Postman

1. Open Postman and create a new POST request.
2. Set the Request URL to:

https://api-prod-eu-central-1.inappnavi.com/api/public/v1/{{tenantId}}/discovery/discoveryApps

3. Compose the Body:
   1. In the Body tab, choose raw and then JSON.
   2. Enter the required parameters in the request body.

{
  "queryParams": {
    "page": 1,
    "itemsPerPage": 25,
    "fromDate": "2024-01-21 00:00:00",
    "toDate": "2025-01-21 00:00:00",
    "timeRange": "VIEW_CUSTOM_DAYS",
    "displayedColumns": ["url", "title", "vendor"]
  }
}

4. Authentication Bearer token

   1. Acquire Authentication Token click

{
    "ClientId": "example-client-id",
    "ClientSecret": "exampleClientSecret"
}

5. Send the Request:
6. Click Send.
7. If everything is correct, you should receive a 200 OK response with a JSON payload containing the discovered apps data.

Response Behavior:

• The result array contains objects with only the requested columns.
• Each object inside result includes only the columns requested in the API query.
• The structure of each object may vary depending on the requested fields.
• errorMessage will be null if the request is successful; otherwise, it will contain error details.
• metaData provides pagination information such as current page and items per page.

Example Response:

{
  "result": [
    {
      "title": "Example App",
      "url": "https://example.com",
      "vendor": "Example Vendor"
    }
  ],
  "errorMessage": null,
  "metaData": {
    "page": 1,
    "itemsPerPage": 25
  }
}