Skip to main content
Gainsight Inc.

Adoption Explorer APIs

Gainsight NXT

This article supports Gainsight NXT, the next evolution of the Customer Success platform. If you are using Gainsight CS Salesforce Edition, you can find supporting documentation by visiting the home page, and selecting CS > Salesforce Edition.

Not sure what your team is using? Click here.

 

The Adoption Explorer (AE) APIs are organized around REST (Representational State Transfer). This article explains to the admins how these REST APIs can be used to fetch AE Project execution status.

Overview

Adoption Explorer allows admins to build projects based on the customer’s usage data in the Gainsight environment. With the AE REST APIs, admins can access and check the status of the AE Project Logs from the external systems. Sometimes, this is extremely critical for some of the customers, especially who are in the security businesses.

These APIs allow admins to fetch the Project Log details up to Job and Sub Job levels. Admins can also fetch the data process/load information of a job, sub job and Company data resolution details with csv links.

Example Business Use Case: All the teams who benefit from accessing AE do not always use Gainsight. Such customers expect better Gainsight integration with the systems of their choice. In such scenarios, AE APIs allow customers to access and check the AE job statuses from their external systems. Customers who have the development resources can use these APIs to build tighter and more customized integrations between Gainsight and other systems they use. 

For information on how to schedule/run a project manually in Adoption Explorer, refer to the LOGS article from the Additional Resources section.

Prerequisites

To use the AE APIs, ensure that you generate Access Token:

API Authentication: API access is controlled using a unique Access Key. Contact your Gainsight Admin to get an access key of the Gainsight tenant to which you want to send REST API requests. For more information on how to generate or share an access key, refer to the Generate API Access Key article from the Additional Resources section.

Once you get the access key, pass the access key as part of the request header ‘accesskey’ for all the API requests into Gainsight. The Access Key does not expire.

Fetch Project Details

The Fetch Project Details API allows you to fetch the project details by projectName or projectId. The projectName or projectId is required, however, if you specify both the details, the projectName is considered.

This API fetches the following fields of a project:

  • ProjectId
  • Project Name
  • Status
  • Created By Name
  • Modified By Name

Method Details

API Details Description
Endpoint URL <apiGatewayURL>/v1/udm/integrationapi/projectDetails
Request Method GET
Headers

accesskey: <GainsightAPI accessKey>

projectName: <projectName>

projectId: <projectId>

optionalResponseParams: companyEnabledDetails,personEnabledDetails,secondaryCompanyExist,additionalDetails

Note: To get a more concise response, provide the predefined optionalResponseParams separated by a comma.

Sample Request

The following is the example of a request for Fetch Project Details API:

curl --location --request GET 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/projectDetails' \
--header 'projectName: Horizon UI Do Not touch' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \--header 'optionalResponseParams;' \

Sample Success Response

The following is the example of a successful response for Fetch Project Details API:

{
    "result": true,
    "requestId": "4b72749f-2b1f-4fa5-be62-0b8e175b60b7",
    "data": {
        "id": 732,
        "projectId": "9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5",
        "name": "Horizon UI Do Not touch",
        "status": "ACTIVE",
        "createdByName": "Arvind Singh",
        "modifiedByName": "Arvind Singh"
    }
}

Sample Failure Response

The following is the example of a failure response for Fetch Project Details API:


{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "30e7d770-a58b-4290-86c7-ba8bc53a4c3c",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
} 

Fetch Job Details

The Fetch Job Details API allows you to fetch the job details of an AE Project by Project Id. If you do not know the projectId, you can fetch the details using the Fetch Project Details API call. For more information, refer to the Fetch Project Details section in this article.

This API fetches the following details of a job, depending on the Payload Conditions applied:

  • Created By
  • Last Modified At
  • Tenant Id
  • Job Id
  • Job status
  • Schedule Frequency
  • Run for Date
  • Type
  • Start Time
  • Type

For more information on the Payload Conditions, refer to the Payload Conditions section in this article.

Method Details

API Details Description
Endpoint URL <apiGatewayURL>/v1/udm/integrationapi/jobDetails
Request Method POST
Headers accesskey: <GainsightAPI accessKey>

projectId: <projectId>

optionalResponseParams: udmJobId,dpPrimaryJobId
Query Params

limit: 30

Offset: 0

order_by: modified_at

descending: true

Note: All the Query Params are optional and are honored only when provided.

Payload Conditions [Optional]

The payload is optional and when provided, filters are constructed accordingly to return the result.

Supported Filter Fields: job_status, run_for_date, start_time, modified_at, schedule_frequency, type.

Supported Operators: EQ, NE, IS_NULL, IS_NOT_NULL, LT, GT, LTE, GTE (Some operators are valid only for date fields).

Supported Values:

  • job_status - ABORTED, FAILED, PARTIAL_SUCCESS, STARTED, SUCCESS
  • schedule_frequency - WEEKLY, DAILY, MONTHLY,YEARLY, ALL_RECORD_DELETE, SELECTIVE_RECORD_DELETE, ALL_CM_UPDATE,GPX_BOOT, GPX_SPLITTER, etc.

Sample Payload Condition

The following is the example of a payload condition request for Fetch Job Details API:

{
  "condition": "and",
  "rules": [
    {
      "op": "EQ",
      "apiOp": "EQ",
      "values": [
        {
          "value": "PARTIAL_SUCCESS",
          "dataType": "string",
          "fieldType": "value"
        }
      ],
      "fieldInfo": {
        "name": "job_status",
        "dataType": "string",
        "fieldType": "field",
        "fieldAlias": "Status"
      }
    },
    {
      "op": "GT",
      "apiOp": "GT",
      "values": [
      
{
          "value": "2020-12-01",
          "dataType": "date",
          "fieldType": "value"
        }
      ],
      "fieldInfo": {
        "name": "run_for_date",
        "dataType": "date",
        "fieldType": "field",
        "fieldAlias": "Run Date"
      }
    }
  ]
}

Sample Request

The following is the example of a request for Fetch Job Details API:

curl --location --request POST 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/jobDetails?limit=50&offset=0&order_by=modified_at&descending=true' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \
--header 'projectId: 9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5' \
--header 'optionalResponseParams: udmJobId,dpPrimaryJobId' \

Sample Success Response

The following is the example of a successful response for Fetch Job Details API:

{
  "result": true,
  "requestId": "c757f528-ac1a-4389-99dc-4e3eaa47d391",
  "data": [
    {
      "createdByName": "Arvind Singh",
      "lastModifiedAt": "2020-03-26 09:33:03.528703",
      "id": 48850,
      "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
      "udmJobId": "728b3e33-b061-458a-a8f9-3a6f0826a41c",
      "dpPrimaryJobId": "",
      "jobStatus": "SUCCESS",
      "scheduleFrequency": "external_identifiers_update",
      "runForDate": "2020-03-26",
      "type": "MANUAL",
      "startTime": "2020-03-26 09:32:44.523",
      "testRun": false
    },
    {
      "createdByName": "Arvind Singh",
      "lastModifiedAt": "2020-03-26 10:08:20.644",
      "id": 48906,
      "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
      "udmJobId": "ef8a8196-a4ee-4a51-8897-c5d837997934",
      "dpPrimaryJobId": "",
      "jobStatus": "SKIPPED",
      "scheduleFrequency": "daily",
      "runForDate": "2020-02-01",
      "message": "Skipping daily jobs older than last 45 days, will schedule only weekly jobs for skipped date range only if weekly sources are present",
      "type": "MANUAL",
      "startTime": "",
      "testRun": false
    }
  ]
}

Sample Failure Response

The following is the example of a failure response for Fetch Job Details API:

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "dffa8808-8097-43f4-9782-f224558a5d44",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
}

Fetch Sub Job Details

The Fetch Sub Job Details API allows you to fetch the sub job details for a given AE Project and Job. If you do not know the projectId and jobId, you can fetch the details using the Fetch Project Details and Fetch Job Details API calls respectively. For example, there might be multiple Objects in a Project and you want to know the detailed log information of an Object.

This API fetches the following details of a sub job (for both Data Process and Data Load),  depending on the ResponseParams input:

  • Sub Job Type
  • Last Modified At
  • Sub Job Id
  • Sub Job Status
  • Data Load Type
  • Run for Date
  • Start Time
  • Display Name

For more information on how to fetch details of a Project, refer to the Fetch Project Details section in this article.

For more information on how to fetch details of a Job, refer to the Fetch Job Details section in this article.

Method Details

API Details Description
Endpoint URL <apiGatewayURL>/v1/udm/integrationapi/subJobDetails
Request Method POST
Headers

accesskey: <GainsightAPI accessKey>

projectId: <projectId>

jobId: <jobId>

optionalResponseParams: dpProcessUdmJobId, dpProcessSubJobId, dpProcessDpPrimaryJobId, dpProcessDpSubJobId, dlProcessUdmJobId, dlProcessSubJobId, dlProcessDpPrimaryJobId, dlProcessDpSubJobId

Notes:

  • To get a more concise response, provide the predefined optionalResponseParams separated by a comma.
  • In optionalResponseParams, dp denotes Data Process and dl denotes Data Load.

Sample Request

The following is the example of a request for Fetch Sub Job Details API:

 curl --location --request POST 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/subJobDetails' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \
--header 'projectId: 9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5' \
--header 'jobId: 8af8c4c1-fa3c-4d25-81ed-b4c5bc75fbcc' \

Sample Success Response

The following is the example of a successful response for Fetch Sub Job Details API:

{
  "result": true,
  "requestId": "95999e35-fcaf-46b9-b163-1b75fa5ba56c",
  "data": [
    {
      "subjobType": "COMPANY_AVATAR",
      "dpProcess": {
        "lastModifiedAt": "2021-02-01 07:09:18.146365",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "d1e18354-efdf-4c51-a35d-cc40d164d8e5",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "20210201070059279-udm-9de7-b9603b44-43e4-425f-9a95-58e42bab35e3",
        "subJobStatus": "PARTIAL_SUCCESS",
        "dataLoadType": "COMPANY_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:00:58.747",
        "displayName": "COMPANY INFORMATION"
      },
      "dataLoad": {
        "lastModifiedAt": "2021-02-01 07:09:21.331238",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "63e8e12d-8224-4a7f-9834-18e736ea3c62",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "",
        "subJobStatus": "SUCCESS",
        "dataLoadType": "COMPANY_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:09:18.164",
        "displayName": "COMPANY INFORMATION"
      }
    },
    {
      "subjobType": "PERSON_AVATAR",
      "dpProcess": {
        "lastModifiedAt": "2021-02-01 07:12:56.571328",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "a89512a7-fe04-4391-b964-04cdfd3179c8",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "20210201070923000-udm-9de7-8d5b6ed5-cbae-40f5-ac42-6e10962a55a3",
        "subJobStatus": "PARTIAL_SUCCESS",
        "dataLoadType": "PERSON_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:09:21.353",
        "displayName": "PERSON INFORMATION"
      },
      "dataLoad": {
        "lastModifiedAt": "2021-02-01 07:12:58.687005",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "fd24ddb0-b473-4516-add5-ce43318effec",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "",
        "subJobStatus": "SUCCESS",
        "dataLoadType": "PERSON_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:12:56.587",
        "displayName": "PERSON INFORMATION"
      }
    }
  ]
} 

Sample Failure Response

The following is the example of a failure response for Fetch Sub Job Details API:

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "76c76670-cc40-4df9-8b97-d1a701a924b0",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
}

Fetch Download Links

This Fetch Download Links API allows you to fetch the data load information with csv links, for a given AE Project > Job > Sub Job > Load Type. If you do not know the projectId, jobId, and subJobId, you can fetch the details using the Fetch Project Details, Fetch Job Details and Fetch Sub Job Details API calls respectively. 

If you want to generate the complete report on data process and data load operations, you can use this API to understand the number of records that are valid, invalid, and the number of records that are loaded to the Object after removing the duplicates. 

This API fetches the following details of the download link:

  • Link Type
  • Download Link
  • Type

For more information on how to fetch details of a Project, refer to the Fetch Project Details section in this article.

For more information on how to fetch details of a Job, refer to the Fetch Job Details section in this article.

For more information on how to fetch details of a Sub Job, refer to the Fetch Sub Job Details section in this article.

Method Details

API Details Description
Endpoint URL <apiGatewayURL>/v1/udm/integrationapi/downloadLinks
Request Method GET
Headers

accesskey: <GainsightAPI accessKey>

projectId: <projectId>

jobId: <jobId>

osubJobId : <subJobId>

loadType : <loadType>

loadType can be anything among the following: COMPANY_AVATAR,PERSON_AVATAR,
COMPANY_AVATAR_WEEKLY,
PERSON_AVATAR_WEEKLY,
PERSON_DAILY_TIME_SERIES, etc.

Sample Request

The following is the example of a request for Fetch Download Links API:

 curl --location --request GET 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/downloadLinks' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \
--header 'projectId: 9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5' \
--header 'jobId: b81c4e20-3461-4c75-b603-8276472cac54' \
--header 'subJobId: d1e18354-efdf-4c51-a35d-cc40d164d8e5' \--header 'loadType: COMPANY_AVATAR' \

Sample Success Response

The following is the example of a successful response for Fetch Download Links API:

{
    "result": true,
    "requestId": "58b9a712-3353-4ddb-b8b8-a1dbbb66e5a4",
    "data": [
        {
            "linkType": "SDJHJHSD",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/8ffaf7a4-194d-4836-8a89-c04a67981ba3/VALID_DATA/downloadReady/cad_104_COMPANY_AVATAR_DAILYmerge_1612163108250.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b236e10ee05cba5d7bd0f82f545252c3f94d8a3cf6625315007e7cef596acbe5",
            "numberOfRecords": 0,
            "type": "VALID"
        },
        {
            "linkType": "SDJHJHSD",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/8ffaf7a4-194d-4836-8a89-c04a67981ba3/INVALID_DATA/downloadReady/cad_105_COMPANY_AVATAR_DAILYmerge_1612163109344.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=a8994a75b2ad15bec0d5f912702a621bc2e93996c9e1859a07eff072ef97e519",
            "numberOfRecords": 0,
            "type": "INVALID"
        },
        {
            "linkType": "SDJHJHSD",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/8ffaf7a4-194d-4836-8a89-c04a67981ba3/EXTRACTION/downloadReady/cad_103_COMPANY_AVATAR_DAILYmerge_1612163091256.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9d481efc42985b02fb68eb302026d8f48cbb15aac56ee161f8e5b9b5c2191ec3",
            "numberOfRecords": 0,
            "type": "SOURCE"
        },
        {
            "linkType": "MDA_CUI",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/cbde781a-924e-47a0-a57e-082f85f81d21/EXTRACTION/downloadReady/cad_101_COMPANY_AVATAR_DAILYMDA3_1612163109380.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f15b86574d973c1ecae71b15c21a849d8d75271802db809e495f049e5dffc3cf",
            "numberOfRecords": 2551,
            "type": "SOURCE"
        },
        {
            "linkType": "MDA_CUI",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/cbde781a-924e-47a0-a57e-082f85f81d21/VALID_DATA/downloadReady/cad_102valid_1612163145431.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=205d3a7ac61ded1c55a595935adbb705ff67cb519ed45524963959be8ea1c285",
            "numberOfRecords": 1006,
            "type": "VALID"
        },
        {
            "linkType": "MDA_CUI",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/cbde781a-924e-47a0-a57e-082f85f81d21/INVALID_DATA/downloadReady/cad_102invalid_1612163147534.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=df38e513a6053fd96bcbccec0ffa37d83f89511ce4de6caa09f50db70c19ba6a",
            "numberOfRecords": 1545,
            "type": "INVALID"
        },
        {
            "linkType": "Company Information",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/FINAL_OUTPUT_TASK/downloadReady/cad_106_COMPANY_AVATAR_DAILYjoin_1_1612163233401.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b99e447b62773723d8d2a803adf0d63e81ecded1dc2d871659445dd6467edafc",
            "numberOfRecords": 1004,
            "type": "OBJECT"
        }
    ]
}

Sample Failure Response

The following is the example of a failure response for Fetch Download Links API:

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "c12a3bfb-d1a2-4d74-8ce2-26fffe128a3c",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
} 

Fetch Company Resolution Download Link

The Fetch Company Resolution Download Link API allows you to fetch the data load information of the Company resolution with csv links, for a given AE Project > Job. If you do not know the projectId and jobId, you can fetch the details using the Fetch Project Details and Fetch Job Details API calls respectively.

If you want to generate the complete report on data process and data load operations, you can use this API to understand the number of default records that are cleaned-up, and a number of records that are loaded to the Object after removing the duplicates.

This API fetches the following details of the download link:

  • Link Type
  • Download Link
  • Type

For more information on how to fetch details of a Project, refer to the Fetch Project Details section in this article.

For more information on how to fetch details of a Job, refer to the Fetch Job Details section in this article.

Method Details

API Details Description
Endpoint URL <apiGatewayURL>/v1/udm/integrationapi/companyResolutionDownloadLink
Request Method GET
Headers

accesskey: <GainsightAPI accessKey>

projectId: <projectId>

jobId: <jobId>

Sample Success Response

The following is the example of a successful response for Company Resolution Download Link API:

{
    "result": true,
    "requestId": "b10f2502-c1be-4e4b-ab13-3bdb81540f4d",
    "data": [
        {
            "linkType": "DEFAULT_RECORDS",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/fb13a0f8-4dea-4564-ac07-b72b07c2489c/COMPANY_RESOLUTION/default_records_sched-ca30c47c-09bb-4c5c-8b1b-10f411f57ae7.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T092043Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=bc9fdd19593d590179b86078ca88b8aec2d6100b142d15f7908f1e8211681d20",
            "numberOfRecords": 0,
            "type": "OBJECT"
        }
    ]
}

Sample Failure Response

The following is the example of a failure response for Company Resolution Download Link API:

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "3ec598ae-d963-40ff-9922-481cd993112c",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
} 

Additional Resources

  • For information on how to schedule/run a project manually in Adoption Explorer, refer to the LOGS article. 
  • For information on how to generate or share an access key, refer to the Generate API Access Key article.
  • Was this article helpful?