Get the sitemap for a published Destination | Documentation

{
  "property": {
    "sys": {
      "type": "Destination"
    }
  },
  "paths": {
    "sys": {
      "type": "Array"
    },
    "limit": 100,
    "items": [
      {
        "sys": {
          "type": "DestinationExperienceNode"
        },
        "path": "/",
        "experienceUrn": "crn:contentful:::experience:spaces/$self/environments/$self/experiences/homepage"
      },
      {
        "sys": {
          "type": "DestinationExperienceNode"
        },
        "path": "/products",
        "experienceUrn": "crn:contentful:::experience:spaces/$self/environments/$self/experiences/productIndex"
      }
    ],
    "pages": {
      "next": "bnVsbDoxMDA"
    }
  }
}

Returns the flattened sitemap for a published Destination. The route has no environment segment, so it always resolves the master environment.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

ID of the space.

destinationIdstringRequired

ID of the published Destination.

Query parameters

limitintegerOptional

Maximum number of paths to return. Defaults to 100, maximum 1000.

pageNextstringOptional

Cursor returned as paths.pages.next by a previous request. Treat the value as opaque and do not combine it with pagePrev.

pagePrevstringOptional

Cursor returned as paths.pages.prev by a previous request. Treat the value as opaque and do not combine it with pageNext.

Response

OK - Request successful

propertyobject

The Destination the sitemap belongs to.

pathsobject

Flattened, paginated list of every routable path in the Destination.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error