Integrations

Enable or disable a reporting integration

Changed on

Pauses or resumes collection for an existing integration without disconnecting it. For Search Console, an account administrator with integration-management permission can also explicitly keep reads restricted to stored Board hostnames or authorize the entire selected Google property.

patch/integrations/reporting/{provider}

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/integrations/reporting/{provider}
  • Auth: HTTP bearer

Path parameters

provider'search_console' | 'adsense' | 'tinybird' | 'stripe' | 'google_analytics' required

The reporting provider key. tinybird is deprecated: first-party Board analytics need no connection and are served live by the /v1/analytics endpoints, so connecting it changes nothing.

Request body

enabledboolean

Whether collection is enabled for this integration.

searchConsoleCoverageMode'board_hosts' | 'whole_property'

Search Console only. board_hosts restricts reads to stored Board hostnames; whole_property explicitly authorizes the entire selected Google property.

Response

Successful response.

idstring required

Unique identifier for the integration.

object'reporting_integration' required

String representing the object's type.

provider'search_console' | 'adsense' | 'tinybird' | 'stripe' | 'google_analytics' required

The reporting provider key. tinybird is deprecated: first-party Board analytics need no connection and are served live by the /v1/analytics endpoints, so connecting it changes nothing.

enabledboolean required

Whether collection is enabled for this integration.

connectedboolean required

Whether the connection has completed successfully.

connectedAtstring nullable required

ISO-8601 timestamp of when the integration was connected.

Changes