The Market Dojo API

The Market Dojo API

What is the issue you're facing?

I would like to connect to the Market Dojo API. How can I do this?

Solution

Market Dojo can be accessed programmatically using the API.

Steps

  1. Login to Market Dojo

  2. Go to your profile page, make a note of your E-mail and Market Dojo API Key

  3. Go to https://secure.marketdojo.com/api/v1/documentation  

  4. Review the available endpoints to understand how the API works

  5. Note that you can experiment with the API directly from the documentation page

What are the reporting APIs

Market Dojo provides a number of API endpoints designed for use with reporting tools such as Power BI.

In addition to the endpoints listed below, v1 API endpoint documentation can be found at https://gl.marketdojo.com/api/v1/documentation

Using the reporting APIs

Requests must be made to either:

- https://secure.marketdojo.com, or

- your company’s configured domain (e.g., https://acme.marketdojo.com or https://procurement.acme.com).


Requests with a host header for any other domain are blocked.


The reporting APIs take 2 standard parameters:

email: the email of the user who is accessing the endpoint

api_key : the users api key (this can be found on their profile page in the market dojo application)


If using the endpoints from the command line, it may be necessary to enclose the url in quotation marks.


e.g.

curl 'https://secure.marketdojo.com/api/v2/reports/contracts?email=email&api_key=api_key'


Results are returned in JSON format.

Things to check

  • Is the user a member of the (default) group, if not they will receive a 403 error

Obtaining an API Key

An API Key is required in order to use the API.

Follow instructions here to obtain your API Key.

If you do not see the option to create or view your API Key, please ask your superhost to enable the API on the Admin>Integrations page.


Available reporting API endpoints

Companies

https://secure.marketdojo.com/api/v2/reports/companies?email=email&api_key=key


This endpoint will return information about the user’s company.

Users

https://secure.marketdojo.com/api/v2/reports/users?email=email&api_key=key


This endpoint will return information about all users in the company.

Contracts

https://secure.marketdojo.com/api/v2/reports/contracts?email=email&api_key=key



This endpoint will return details of the contracts which the user has access to view.

Events

https://secure.marketdojo.com/api/v2/reports/events?email=email&api_key=key


This endpoint will return details of the events which the user has access to view.

Questionnaire

https://secure.marketdojo.com/api/v2/reports/questionnaires/:id?email=email&api_key=key


This endpoint will return details of a questionnaire, including the responses that it has received.

NOTE: :id should be replaced with the id (a number) of the questionnaire.

SIM Participants

https://secure.marketdojo.com/api/v2/reports/sim_participants?email=email&api_key=key


This endpoint will return details of the participants in a Supplier onboarding event.


SRM

https://secure.marketdojo.com/api/v2/reports/srm?email=email&api_key=key


This endpoint will return details of a user's SRM suite. Information such as srm_accounts, srm_contacts activities and events.