Skip to content

SDK method

tools.getCampaignReport

Get campaign report. Convenience alias for get_campaign_report, forwarding to tinbox.api.campaigns.report.query.

Signature

ts
getCampaignReport(input: Parameters<TinboxTools["getCampaignReport"]>[0]): ReturnType<TinboxTools["getCampaignReport"]>

Parameters

NameTypeRequiredDescription
idstringyesThe campaign id.

Returns

ReturnType<TinboxTools["getCampaignReport"]>

Example

ts
await tinbox.tools.getCampaignReport({
  "id": "<id>"
});