DashboardCharts

Delete a saved chart

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/dashboard-charts/{pageContext}/{chartId}

Any user at the company with access to this page's chart feature may delete any saved chart under this pageContext — saved charts are shared, not per-user.

Delete a saved chart › path Parameters

companyId

string · uuid · required

pageContext

string · required

chartId

integer · int32 · required

Delete a saved chart › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Delete a saved chart › Responses

Deleted

List saved charts for a page

GET

https://api.gosmarter.ai

/api/company/{companyId}/dashboard-charts/{pageContext}

Returns every chart the company has saved for this pageContext. Cheap: metadata + spec JSON only, no chart data.

List saved charts for a page › path Parameters

companyId

string · uuid · required

pageContext

string · required

List saved charts for a page › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List saved charts for a page › Responses

Saved charts, newest first

savedDashboardChartDto[]

savedDashboardChartDto

savedDashboardChartId

integer · int32

companyId

string · uuid

pageContext

string

createdBy

string · uuid

name

string

chartSpecJson

string

promptText

string

modelDeployment

string

promptVersion

string

createdAt

string · date-time

updatedAt

string · date-time

Save a chart spec to the company's shared dashboard

POST

https://api.gosmarter.ai

/api/company/{companyId}/dashboard-charts/{pageContext}

Persists a validated chart spec, name, and audit metadata. Visible and deletable by any user at the company with access to this page's chart feature.

Save a chart spec to the company's shared dashboard › path Parameters

companyId

string · uuid · required

pageContext

string · required

Save a chart spec to the company's shared dashboard › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Save a chart spec to the company's shared dashboard › Request Body

saveChartRequest

name

string

chartSpecDto

promptText

string

modelDeployment

string

promptVersion

string

Save a chart spec to the company's shared dashboard › Responses

The saved chart

savedDashboardChartDto

savedDashboardChartId

integer · int32

companyId

string · uuid

pageContext

string

createdBy

string · uuid

name

string

chartSpecJson

string

promptText

string

modelDeployment

string

promptVersion

string

createdAt

string · date-time

updatedAt

string · date-time

POST/api/company/{companyId}/dashboard-charts/{pageContext}

curl https://api.gosmarter.ai/api/company/:companyId/dashboard-charts/:pageContext \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "chartSpec": {
    "pageContext": "pageContext",
    "title": "title",
    "chartType": "chartType",
    "datasets": [
      "string"
    ],
    "joinField": "joinField",
    "filters": [
      {
        "field": "field",
        "op": "op",
        "value": {}
      }
    ],
    "groupBy": [
      "string"
    ],
    "measure": {
      "field": "field",
      "agg": "agg"
    },
    "sort": {
      "field": "field",
      "direction": "direction"
    },
    "limit": 0
  },
  "promptText": "promptText",
  "modelDeployment": "modelDeployment",
  "promptVersion": "promptVersion"
}'

Example Request Body

{
  "name": "name",
  "chartSpec": {
    "pageContext": "pageContext",
    "title": "title",
    "chartType": "chartType",
    "datasets": [
      "string"
    ],
    "joinField": "joinField",
    "filters": [
      {
        "field": "field",
        "op": "op",
        "value": {}
      }
    ],
    "groupBy": [
      "string"
    ],
    "measure": {
      "field": "field",
      "agg": "agg"
    },
    "sort": {
      "field": "field",
      "direction": "direction"
    },
    "limit": 0
  },
  "promptText": "promptText",
  "modelDeployment": "modelDeployment",
  "promptVersion": "promptVersion"
}

json

Example Responses

{
  "savedDashboardChartId": 0,
  "companyId": "00000000-0000-0000-0000-000000000000",
  "pageContext": "pageContext",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "chartSpecJson": "chartSpecJson",
  "promptText": "promptText",
  "modelDeployment": "modelDeployment",
  "promptVersion": "promptVersion",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Propose a chart spec from a natural-language prompt

POST

https://api.gosmarter.ai

/api/company/{companyId}/dashboard-charts/{pageContext}/chart-spec/propose

Returns a validated ChartSpec for client-side preview. Never persisted — call SaveChart to keep it. Rate limited to 20 calls per company per 24 hours.

Propose a chart spec from a natural-language prompt › path Parameters

companyId

string · uuid · required

pageContext

string · required

The registered dataset catalogue to propose against, e.g. 'sales-orders-insights'.

Propose a chart spec from a natural-language prompt › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Propose a chart spec from a natural-language prompt › Request Body

proposeChartSpecRequest

prompt

string

Propose a chart spec from a natural-language prompt › Responses

Validated chart spec

proposeChartSpecResponse

chartSpecDto

promptVersion

string

modelDeployment

string

POST/api/company/{companyId}/dashboard-charts/{pageContext}/chart-spec/propose

curl https://api.gosmarter.ai/api/company/:companyId/dashboard-charts/:pageContext/chart-spec/propose \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "prompt": "prompt"
}'

Example Request Body

{
  "prompt": "prompt"
}

json

Example Responses

{
  "chartSpec": {
    "pageContext": "pageContext",
    "title": "title",
    "chartType": "chartType",
    "datasets": [
      "string"
    ],
    "joinField": "joinField",
    "filters": [
      {
        "field": "field",
        "op": "op",
        "value": {}
      }
    ],
    "groupBy": [
      "string"
    ],
    "measure": {
      "field": "field",
      "agg": "agg"
    },
    "sort": {
      "field": "field",
      "direction": "direction"
    },
    "limit": 0
  },
  "promptVersion": "promptVersion",
  "modelDeployment": "modelDeployment"
}

json

application/json

Insights Me