Get Map | Aviato API

curl -G https://data.api.aviato.co/marketmap/get \
     -H "Authorization: Bearer <token>" \
     -d id=id

{
  "targetCompany": {
    "name": "name",
    "website": "website",
    "id": "id",
    "description": "description",
    "logoURL": "logoURL",
    "stage": "stage"
  },
  "status": "pending",
  "similarCompanies": {
    "categories": [
      {
        "name": "name",
        "description": "description",
        "similarCompanies": [
          {
            "name": "name",
            "companyName": "companyName",
            "productName": "productName",
            "whySimilar": "whySimilar",
            "companyWebsite": "companyWebsite",
            "companyId": "companyId",
            "id": "id",
            "description": "description",
            "logoURL": "logoURL",
            "stage": "stage"
          },
          {
            "name": "name",
            "companyName": "companyName",
            "productName": "productName",
            "whySimilar": "whySimilar",
            "companyWebsite": "companyWebsite",
            "companyId": "companyId",
            "id": "id",
            "description": "description",
            "logoURL": "logoURL",
            "stage": "stage"
          }
        ]
      },
      {
        "name": "name",
        "description": "description",
        "similarCompanies": [
          {
            "name": "name",
            "companyName": "companyName",
            "productName": "productName",
            "whySimilar": "whySimilar",
            "companyWebsite": "companyWebsite",
            "companyId": "companyId",
            "id": "id",
            "description": "description",
            "logoURL": "logoURL",
            "stage": "stage"
          },
          {
            "name": "name",
            "companyName": "companyName",
            "productName": "productName",
            "whySimilar": "whySimilar",
            "companyWebsite": "companyWebsite",
            "companyId": "companyId",
            "id": "id",
            "description": "description",
            "logoURL": "logoURL",
            "stage": "stage"
          }
        ]
      }
    ]
  }
}

Fetch the data for the generated market map.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idstringRequired

The market map ID which was returned from the generate map request.

Response

This endpoint returns an object.

targetCompanyobject

statusenum

Allowed values:

similarCompaniesobject

Errors

400

Bad Request Error

400

Bad Request Error

401

Unauthorized Error

404

Market Map Not Found Error

429

Rate Limit Error

500

Market Map Server Error