Performance Dashboards Api Service

Update editable fields of a Performance Dashboard.

patch/v2/reporting/campaigns-dashboard/{dashboardId}

Request

  • Base URL: https://app.metricool.com/api
  • URL: https://app.metricool.com/api/v2/reporting/campaigns-dashboard/{dashboardId}
  • Auth: none declared

Path parameters

dashboardIdinteger required

Dashboard id.

Query parameters

fieldsstring[] required

Editable fields to update: 'title', 'description', 'views_goal', 'interactions_goal', 'clicks_goal'. Note the 3 goal fields use snake_case, unlike 'title'/'description'.

Request body

titlestring

Dashboard title.

descriptionstring

Dashboard description.

viewsGoalinteger

Views/impressions goal to reach. Available on any dashboard.

interactionsGoalinteger

Interactions goal to reach. Requires at least one organic network in the dashboard.

clicksGoalinteger

Paid clicks goal to reach. Requires at least one ads network in the dashboard.

Example request

{
  "title": "My dashboard title",
  "description": "This is a description.",
  "viewsGoal": 200000,
  "interactionsGoal": 5000,
  "clicksGoal": 1000
}

Response

OK

metadataobject

Changes

No recorded changes to this operation across all 6 revisions of this API.