Dashboards

Methods in this section: 2. All methods

Method	Path	Description	Scopes	Status
GET	`/dashboards/overview`	The Overview dashboard	`dashboards:read`	Available
GET	`/dashboards/pulse`	The Pulse dashboard	`dashboards:read`	Available

GET /dashboards/overview Available

#The Overview dashboard

A slice of the Overview screen: up to eleven blocks, each with its own availability (ok, no_data, no_source, not_connected) and data date. A source failure never becomes an empty block: the answer is 503.

Scopes: dashboards:read
Rate limit: read
Idempotency: not required
Successful response: 200 The requested blocks in screen order.

Parameters

Field	Type	Description
`from`	string optional	In: query. Start of the period, inclusive. Format YYYY-MM-DD.
`to`	string optional	In: query. End of the period, inclusive; not later than the last full day (a later value is clamped and echoed in the response). Format YYYY-MM-DD.
`blocks`	string optional	In: query. Blocks, comma-separated; all by default: strategist, kpi, funnel, attention, ads, ai_assistants, popular_pages, clusters, data_trust, sitemap_health, status.

Response body

Field	Type	Description
`data`	object required
`data.from`	string required	Date YYYY-MM-DD.
`data.to`	string required	Date YYYY-MM-DD.
`data.blocks`	object required
`data.blocks.strategist`	object optional
`data.blocks.strategist.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.strategist.reason`	string optional
`data.blocks.strategist.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.kpi`	object optional
`data.blocks.kpi.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.kpi.reason`	string optional
`data.blocks.kpi.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.funnel`	object optional
`data.blocks.funnel.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.funnel.reason`	string optional
`data.blocks.funnel.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.attention`	object optional
`data.blocks.attention.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.attention.reason`	string optional
`data.blocks.attention.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.ads`	object optional
`data.blocks.ads.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.ads.reason`	string optional
`data.blocks.ads.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.ai_assistants`	object optional
`data.blocks.ai_assistants.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.ai_assistants.reason`	string optional
`data.blocks.ai_assistants.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.popular_pages`	object optional
`data.blocks.popular_pages.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.popular_pages.reason`	string optional
`data.blocks.popular_pages.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.clusters`	object optional
`data.blocks.clusters.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.clusters.reason`	string optional
`data.blocks.clusters.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.data_trust`	object optional
`data.blocks.data_trust.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.data_trust.reason`	string optional
`data.blocks.data_trust.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.sitemap_health`	object optional
`data.blocks.sitemap_health.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.sitemap_health.reason`	string optional
`data.blocks.sitemap_health.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.
`data.blocks.status`	object optional
`data.blocks.status.availability`	string required	Values: `ok` `no_data` `no_source` `not_connected`
`data.blocks.status.reason`	string optional
`data.blocks.status.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.

Examples

Request

curl -X GET 'https://wfacademy.org/api/public/v1/dashboards/overview' \
  -H 'Authorization: Bearer '"$SAPPORT_API_KEY"

Response 200

{
  "data": {
    "from": "string",
    "to": "string",
    "blocks": {
      "strategist": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "kpi": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "funnel": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "attention": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "ads": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "ai_assistants": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "popular_pages": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "clusters": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "data_trust": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "sitemap_health": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "status": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      }
    }
  }
}

Error example

{
  "type": "https://wfacademy.org/developers/errors#scope_missing",
  "title": "Scope is missing",
  "status": 403,
  "code": "scope_missing",
  "detail": "EXAMPLE",
  "request_id": "req_EXAMPLE"
}

Examples are illustrative: the key in them is a placeholder (EXAMPLE), field values are made up.

Possible errors

invalid_api_key wrong_cell integration_inactive tenant_inactive ip_not_allowed feature_not_in_plan rate_limited wallet_suspended service_unavailable internal_error scope_missing validation_failed

GET /dashboards/pulse Available

#The Pulse dashboard

Pulse findings: demand topics that started to grow, with signal sources and the linked strategist queue topic.

Scopes: dashboards:read
Rate limit: read
Idempotency: not required
Successful response: 200 Findings of the period.

Parameters

Field	Type	Description
`from`	string optional	In: query. Start of the period, inclusive. Format YYYY-MM-DD.
`to`	string optional	In: query. End of the period, inclusive; not later than the last full day (a later value is clamped and echoed in the response). Format YYYY-MM-DD.

Response body

Field	Type	Description
`data`	object required
`data.period`	object required
`data.period.from`	string required	Date YYYY-MM-DD.
`data.period.to`	string required	Date YYYY-MM-DD.
`data.new_7d`	integer required
`data.truncated`	boolean required
`data.alerts`	array<PulseAlert> required
`data.data_as_of`	object required	Source → the date up to which its data is complete. A source with no data is not listed.

Examples

Request

curl -X GET 'https://wfacademy.org/api/public/v1/dashboards/pulse' \
  -H 'Authorization: Bearer '"$SAPPORT_API_KEY"

Response 200

{
  "data": {
    "period": {
      "from": "string",
      "to": "string"
    },
    "new_7d": 0,
    "truncated": false,
    "alerts": [
      {
        "id": null,
        "topic_id": null,
        "topic_name": null,
        "keyword": null,
        "horizon": null,
        "status": null,
        "episode_start": null,
        "last_seen": null,
        "score": null,
        "volume": null,
        "growth": null,
        "sources": null,
        "strategist_topic": null
      }
    ],
    "data_as_of": {}
  }
}

Error example

{
  "type": "https://wfacademy.org/developers/errors#scope_missing",
  "title": "Scope is missing",
  "status": 403,
  "code": "scope_missing",
  "detail": "EXAMPLE",
  "request_id": "req_EXAMPLE"
}

Examples are illustrative: the key in them is a placeholder (EXAMPLE), field values are made up.

Getting started

Chats and AI seller

Analytics and dashboards

CRM and leads

Articles

Strategist

More

API reference

Dashboards

#The Overview dashboard

Parameters

Response body

Examples

Possible errors

#The Pulse dashboard

Parameters

Response body

Examples

Possible errors