Onboarding

Get the org's signup-time suggested namespace

Changed on

Returns the namespace configuration that was suggested from Mixpeek's company research at signup, if one was provisioned. Studio uses this to badge the suggested namespace.

get/v1/onboarding/suggested-config

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/onboarding/suggested-config
  • Auth: HTTP bearer

Response

Successful Response

existsboolean required

Whether a suggestion record exists for this org.

namespace_namestring nullable

Name of the suggested (and provisioned) namespace.

rationalestring nullable

One-sentence, user-facing reason this setup was suggested.

manifest_appliedboolean

True only if the suggested namespace was actually provisioned.

applied_atstring date-time nullable
sample_queriesstring[]

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API