Gainsight Bulk API

Last updated
Save as PDF

Overview

Gainsight Bulk API is a Connector using which you can automate bulk data ingestion from csv/tsv files into MDA objects using APIs. This helps to reduce the complexity in using Gainsight cURL commands and to provide a better user Interface. It allows the user to load data based on Job ID which reads the fields mapping information from the job defined.

Admins can load data into MDA standard and custom objects using Gainsight Bulk API.

Limitation: Gainsight recommends creating a maximum of 4 Bulk API data jobs per hour. If you must exceed this limit, please contact support@gainsight.com for approval.

Note: If you are a developer and want to load your business data into Gainsight objects through APIs without having to login to Gainsight product, refer Gainsight's API Documentation.

To access the GS Bulk API, navigate to Administration > Connectors 2.0 > Connectors. You can see all of the connectors in the Connectors tab and jobs performed through Bulk API and their execution logs in the Data Jobs and Logs tabs respectively.

Admin > Connectors 2.0.png

Using Bulk API, you can ingest data into the following objects:

Company
Relationship
Relationship Type
Any Custom object

Notes:

Using Gainsight Bulk API, you cannot ingest data into the User object and Person object model.
For manual and bulk loading of User records, navigate to the User Management page. For more information, refer User Management.

This article describes how to:

Create a Connection
Ingest Data into the MDA object from a CSV file

Gainsight API Limits

The following are the recommended API limits for Gainsight APIs (The exact limits can vary based on your package):

Synchronous API Calls: 100 API calls per min / 50,000 API call per day
Asynchronous API Calls (Gainsight bulk APIs limit): 10 calls per hour / 100 per day

Note: All of the above API limits are *Fixed window rate limits.

* Fixed window rate limiting restricts the number of API requests at a specific time. For example, a server can have a rate limiting component that implements a fixed window algorithm that only accepts 100 requests per minute. The time-frame is fixed, and it starts at a specific time. For example, the server will only serve 100 requests between 10:00 am, and 10:01 am.