Guides
Start typing to search…

Discovery Apps (v1)

Retrieve applications discovered by users to help locate all web-based applications frequently used within an organization.

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:

ParameterTypeRequiredDescription
QueryParamsQueryParamsYesThe Additional data required to process API request

QueryParams Parameters:

Parameter

Type

Required

Description

fromDate

string

No

Start date in YYYY-MM-DD HH:MM:SS format. If provided, set TimeRange to VIEW_CUSTOM_DAYS.

toDate

string

No

End date in YYYY-MM-DD HH:MM:SS format. If provided, set TimeRange to VIEW_CUSTOM_DAYS.

timeRange

string

No

Possible values include LAST_30_DAYS, VIEW_90_DAYS, VIEW_ALLTIME and VIEW_CUSTOM_DAYS. If set to VIEW_CUSTOM_DAYS, you should provide fromDate and toDate. If not specified default to LAST_30_DAYS.

page

integer

No

The page number to retrieve data from. Defaults to 1.

itemsPerPage

integer

No

The number of items to retrieve per page. Defaults to 50, if not specified.

displayedColumns

Array of Strings

No

The list of property/column names to include in the response. e.g. ["Url"]. Defaults to all columns, if not specified. Available displayedColumns are:
[ id, title, url, vendor, businessCapabilityNames, hosting, notCompliant. userCount, powerUserCount, regularUserCount, occasionalUserCount, activityTime, copyCount, pasteCount, firstSeen, lastSeen, businessCapabilityIds, managed, appNaviAppId, subscriptionId, isUBMActivated, companyApp, organizationalUnit, shouldIncludeOrganizationalUnit, shouldIncludeBusinessCapabilityNames, privacyPolicy, termsOfService, category, saaSMeta, applicationLogo, archivedAt,source, bcSuggestions, isBCTrackingEnabled, criticalityLevel, dataLocation, dataLocationNames, hasPersonalData, hasSensitiveData, isAIProductivityTool, businessProcess, businessProcessNames, dataClassification, dataClassificationNames ]


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
  1. 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,
        "ItemPerPage": 25,
        "DateFrom": "2024-01-21 00:00:00.000",
        "DateTo": "2025-01-21 00:00:00.000",
        "TimeRange": "VIEW_CUSTOM_DAYS",
        "DisplayedColumns" : ["url","copyCount"]
    }
}

  1. Send the Request:

    1. Click Send.
    2. If everything is correct, you should receive a 200 OK response with a JSON payload containing the discovered apps data.

Updated 8 days ago

What’s Next