DashboardCard

Create a dashboard card

This will create a new dashboard card for an org

  • Requires the action org:CreateDashboardCard on the organization
  • Requires the action source_data:Query on the organization, to validate the query

The card_id is generated by the caller and must be a UUID in canonical lowercase form. It must be unique within the org and is never reused: deleting a card retires its id permanently, so every create needs a fresh one.

post/api/v1/org/{orgUID}/dashboard-card/

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/dashboard-card/
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Request body

card_idstring uuid required

Client-generated identifier for the card: a UUID in canonical lowercase form, unique within the org and never reused.

querystring required
schemastring required

The search schema the card's query runs against. May not be model_card_match.

sort_keystring

Dotted path into the matched record naming the card's default sort field. Requires sort_type.

sort_typestring

The declared type of sort_key in its source schema: one of string, double, integer, long, bool, ip. Requires sort_key.

Response

OK

card_idstring
uidstring

UID of the underlying saved query, for support and debugging

Changes

No recorded changes to this operation across all 1 revision of this API.