« Back to Documentation OverviewcampaignShareReport – v1.3
campaignShareReport(string apikey, string cid, array opts)
Get the URL to a customized VIP Report for the specified campaign and optionally send an email to someone with links to it. Note subsequent calls will overwrite anything already set for the same campign (eg, the password)
| Parameters | | apikey | a valid API Key for your user account. Get by visiting your API dashboard |
| cid | the campaign id to share a report for (can be gathered using campaigns()) |
| opts | optional - various parameters which can be used to configure the shared report| string | to_email | optional - optional, email address to share the report with - no value means an email will not be sent | | string | company | optional - a company name to be displayed (use of a theme may hide this) - max 255 bytes | | int | theme_id | optional - either a global or a user-specific theme id. Currently this needs to be pulled out of either the Share Report or Cobranding web views by grabbing the "theme" attribute from the list presented. | | string | css_url | optional - a link to an external CSS file to be included after our default CSS (http://vip-reports.net/css/vip.css) only if loaded via the "secure_url" - max 255 bytes |
|
| Returns | | array |
Array containing details for the shared report
| string | title | The Title of the Campaign being shared
| | string | url | The URL to the shared report
| | string | secure_url | The URL to the shared report, including the password (good for loading in an IFRAME). For non-secure reports, this will not be returned
| | string | password | If secured, the password for the report, otherwise this field will not be returned
| |