links

Call links.report

Check how many clicks this brand's tracked links have had — 'how many clicks did this link get', 'how did this campaign's links perform'. Read how many clicks this brand's tracked links have had — for one piece, one campaign, this week, or the whole brand. Returns a sentence you can say as-is plus the rows behind it, and goes_out_on / domain_is_ours, which tell you whether this brand's links are riding the platform's name or the brand's own. Call this before answering any question about clicks; never guess a number. Not for making a new tracked link — that is links.shorten.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/links.report

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/links.report
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Request body

scope'piece' | 'campaign' | 'week' | 'brand' required

What the numbers are about: one piece, one campaign, this week, or the whole brand.

idstring nullable

The piece's id for piece, or the campaign's name for campaign. Leave it out for week and brand.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes

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