Family

• Generic
  • getGet application KPIs
• Salesforce
  • getGet Salesforce organizations
  • getGet Salesforce organization KPIs
• Servicenow
  • getGet ServiceNow subscriptions
  • postExport ServiceNow subscriptions in a file
  • getGet ServiceNow users
  • postExport ServiceNow users in a file

API docs by Redocly

SaaS: Family (1.0.0)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with SaaS family subscription endpoints.

Generic

Tag for Generic endpoints.

Get application KPIs

Returns the details of a family's application KPIs.

Authorizations:

bearerAuth

query Parameters

fromDate required	string <date> Example: fromDate=2024-11-26 Starting date from which to calculate KPI.
toDate required	string <date> Example: toDate=2024-11-26 Starting date until which to calculate KPI.
subscriptionIds	string Example: subscriptionIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca Comma separated list of subscription IDs.
subscriptionPlanIds	string Example: subscriptionPlanIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca A comma-separated list of subscription plan IDs.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v2/subscription-family/applications/kpi

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "notApproved": 71,
• "total": 56

}

Salesforce

Tag for Salesforce endpoints.

Get Salesforce organizations

Returns a collection of Salesforce organizations for a family.

Authorizations:

bearerAuth

query Parameters

subscriptionPlanIds	string Example: subscriptionPlanIds=5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_06ebc4ee-1bb5-47dd-8120-11324bc54e06,5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_90d8b3f8-712e-4f7b-aa1e-62e7ae6cbe96 A comma-separated list of subscription plan IDs.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
page_number	integer <int32> Default: 1 The page number.
filter	string Example: filter=?filter=Application -eq "abc" For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=Application:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/organizations

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "active": 10,
    • "id": "2f86b198-04f3-4770-ad08-b32518206da0",
    • "inactive": 10,
    • "name": "Salesforce organization name",
    • "noActivity": 1,
    • "potentialSavings": 100,
    • "subscriptionIds": [

      • "2f86b198-04f3-4770-ad08-b32518206da0"

      ],
    • "subscriptions": 20,
    • "totalCost": 100,
    • "totalCostPerYear": 100,
    • "usage": 0.1,
    • "users": 20,
    • "utilization": 98

    }

  ],
• "pagination": {

  • "number": 1,
  • "pageCount": 150

  }

}

Get Salesforce organization KPIs

Returns a collection of Salesforce organizations' key performance indicators.

Authorizations:

bearerAuth

query Parameters

subscriptionPlanIds

string Example: subscriptionPlanIds=5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_06ebc4ee-1bb5-47dd-8120-11324bc54e06,5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_90d8b3f8-712e-4f7b-aa1e-62e7ae6cbe96 A comma-separated list of subscription plan IDs.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/organizations/kpi

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "total": 10,
• "totalCostPerYear": 157.35

}

Servicenow

Tag for ServiceNow endpoints.

Get ServiceNow subscriptions

Returns a collection of ServiceNow subscriptions for a family.

Authorizations:

bearerAuth

query Parameters

subscriptionIds	string Example: subscriptionIds=5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_06ebc4ee-1bb5-47dd-8120-11324bc54e06,5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_90d8b3f8-712e-4f7b-aa1e-62e7ae6cbe96 A comma-separated list of subscription IDs.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
page_number	integer <int32> Default: 1 The page number.
filter	string Example: filter=?filter=Application -eq "abc" For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=Application:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/servicenow/subscriptions

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "purchased": 10,
    • "assigned": 3,
    • "unassigned": 2,
    • "overassigned": 1,
    • "id": "2f86b198-04f3-4770-ad08-b32518206da0",
    • "active": 10,
    • "inactive": 10,
    • "noActivity": 1,
    • "application": "ServiceNow application name",
    • "applicationId": "d8fdde78-60e4-4f81-9e32-6b769176eac0",
    • "applications": [

      • {

        • "appCategoryName": "Document Management",
        • "applicationId": "0dd14c40-965f-432d-b5de-fe8e50677519",
        • "applicationName": "Adobe Acrobat.",
        • "disServiceId": "a5b52a55-515c-48f6-9939-10b12191fe6d"

        }

      ],
    • "automaticallyAdded": false,
    • "connectorName": "ServiceNow connector",
    • "costPerUnit": 32.1,
    • "currency": "USD",
    • "disServiceId": "f3924b69-140c-4587-a15e-ecbb4a9e9998",
    • "discovered": 3,
    • "discoveryTypes": {

      • "0": "SaasConnector"

      },
    • "excludedFromMetrics": false,
    • "expirationDate": "2030-01-02T15:04:05",
    • "familyId": "6c12ebe7-4098-443c-b5b0-80ab0b544a60",
    • "familyName": "ServiceNow Family name",
    • "free": true,
    • "isBundled": true,
    • "name": "ServiceNow subscription name",
    • "notMonitored": 3,
    • "purchasedDate": "2006-01-02T15:04:05",
    • "quantity": 1,
    • "rrpPeriod": "Annually",
    • "rrpValue": 155.88,
    • "startDate": "2006-01-02T15:04:05",
    • "usage": 0.1,
    • "utilization": 98,
    • "vendor": "Adobe Inc.",
    • "vendorId": "0dd14c40-965f-432d-b5de-fe8e50677519",
    • "roleTypes": {

      • "0": "Fulfiller",
      • "1": "Requester"

      },
    • "applicationTypes": {

      • "0": "Case Management",
      • "1": "Incident Management",
      • "2": "Request Management"

      }

    }

  ],
• "pagination": {

  • "number": 1,
  • "pageCount": 150

  }

}

Export ServiceNow subscriptions in a file

Exports a collection of subscriptions for a ServiceNow family.

Authorizations:

bearerAuth

Request Body schema: application/json

Request manage download parameters.

fileName	string File name without extension.
columns	string Columns mappings to include.
fileType	string Enum Description Csv Comma Separated Values file format. Xlsx Microsoft Excel Open XML Spreadsheet file format. File type for downloaded file.
filter	string Filter criteria (e.g., subscriptionIds -eq "abc").

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/servicenow/subscriptions/export

Request samples

• Payload

Content type

application/json

{

• "fileName": "2024-01-01_family_subscriptions",
• "columns": "name:Application,totalUniqueUsers:Total",
• "fileType": "Csv",
• "filter": "subscriptionIds -eq \"abc\""

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "code": 200,
• "body": {

  • "fileContent": "aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==",
  • "fileName": "2006_01_02_family_subscriptions.csv"

  }

}

Get ServiceNow users

Returns a collection of ServiceNow users of a family based on filter query if given. If an insightRuleId is provided, users will be returned from the perspective of the provided insights instead.

Authorizations:

bearerAuth

query Parameters

subscriptionIds	string Example: subscriptionIds=5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_06ebc4ee-1bb5-47dd-8120-11324bc54e06,5c7665c8-1e00-435b-8ad3-b44dcdf6eb62_d76c28a1-0b62-4849-98fd-8cf2516370ce_90d8b3f8-712e-4f7b-aa1e-62e7ae6cbe96 A comma-separated list of subscription IDs.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
page_number	integer <int32> Default: 1 The page number.
insightRuleId	string (InsightRule) Enum Description UsersAssignedNoActivityInsight Identifies users who have been assigned licenses but show no activity. UsersNoActivityLast30DaysInsight Highlights users with no activity in the last 30 days. UsersNotAssignedToAnySubscriptionInsight Detects users not assigned to any subscription. UsersDowngradeFromE3ToE1Insight Flags users downgraded from Microsoft 365 E3 to E1 licenses. UsersDowngradeFromE5ToE3Insight Identifies users downgraded from Microsoft 365 E5 to E3 licenses. UsersDowngradeFromE5ToE1Insight Highlights users downgraded from Microsoft 365 E5 to E1 licenses. UsersUpgradeFromE3ToE5Insight Tracks users upgraded from Microsoft 365 E3 to E5 licenses. UsersDowngradeToAdobeSingleAppInsight Identifies users downgraded to Adobe single-app licenses. UsersWithM365AndDisabledAzureAdInsight Detects users with Microsoft 365 licenses but disabled Azure AD accounts. UsersWithM365AndDisabledAzureAdInsightFamily Identifies users with Microsoft 365 licenses and disabled Azure AD accounts across the organization. Example: insightRuleId=UsersAssignedNoActivityInsight The unique ID of the insight rule.
filter	string Example: filter=?filter=country -eq "abc" For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=country:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/servicenow/users

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "country": "Se",
    • "createdDate": "2030-01-02T15:04:05",
    • "department": "Sales.",
    • "details": [

      • {

        • "applicationName": "Zoom.",
        • "lastActive": "2030-01-02T15:04:05",
        • "lastActiveValueInInt": 1,
        • "lastActiveValueType": 1,
        • "subscriptionName": "Video calls software pro delux edition."

        }

      ],
    • "discoveryTypes": {

      • "0": "SaasConnector"

      },
    • "displayName": "John Doe.",
    • "email": "john@example.com",
    • "id": "c6851b0a-6b85-4c8c-9b27-bfa4d357276c",
    • "isInReview": true,
    • "isOnline": true,
    • "isQualified": true,
    • "lastActive": "2030-01-02T15:04:05",
    • "manuallyAssigned": true,
    • "monthlyCost": 90.99,
    • "status": "Not monitored.",
    • "username": "john@example.com",
    • "roleTypes": {

      • "0": "Admin",
      • "1": "Fulfiller",
      • "2": "Requester"

      },
    • "oobRoles": {

      • "0": "pa_viewer",
      • "1": "catalog_editor",
      • "2": "ais_admin"

      },
    • "customRoles": {

      • "0": "catalog",
      • "1": "client_user",
      • "2": "awa_admin"

      },
    • "webServiceUser": true,
    • "applicationTypes": {

      • "0": "Incident management",
      • "1": "Request management",
      • "2": "Case management",
      • "3": "Security operations"

      },
    • "groups": {

      • "0": "Analyst",
      • "1": "Application dev",
      • "2": "Legal service management team"

      }

    }

  ],
• "pagination": {

  • "number": 1,
  • "pageCount": 150

  }

}

Export ServiceNow users in a file

Exports a collection of ServiceNow users.

Authorizations:

bearerAuth

Request Body schema: application/json

Request manage download parameters.

fileName	string File name without extension.
columns	string Columns mappings to include.
fileType	string Enum Description Csv Comma Separated Values file format. Xlsx Microsoft Excel Open XML Spreadsheet file format. File type for downloaded file.
filter	string Filter criteria (e.g., subscriptionIds -eq "abc").

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/servicenow/users/export

Request samples

• Payload

Content type

application/json

{

• "fileName": "2024-01-01_family_subscriptions",
• "columns": "name:Application,totalUniqueUsers:Total",
• "fileType": "Csv",
• "filter": "subscriptionIds -eq \"abc\""

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "code": 200,
• "body": {

  • "fileContent": "aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==",
  • "fileName": "2006_01_02_family_subscriptions.csv"

  }

}