Back to Documentation Overview

campaignShareReport

public static 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)

Section:
Campaign Related
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
stringheader_typeoptional - "text" or "image', defaults to "text'
stringheader_dataoptional - if "header_type" is text, the text to display. if "header_type" is "image" a valid URL to an image file. Note that images will be resized to be no more than 500x150. Defaults to the Accounts Company Name.
booleansecureoptional - whether to require a password for the shared report. defaults to "true"
stringpasswordoptional - if secure is true and a password is not included, we will generate one. It is always returned.
stringto_emailoptional - optional, email address to share the report with - no value means an email will not be sent
arraythemeoptional - an array containing either 3 or 6 character color code values for: "bg_color", "header_color", "current_tab", "current_tab_text", "normal_tab", "normal_tab_text", "hover_tab", "hover_tab_text"
stringcss_urloptional - 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 characters
Returns:
struct   -  Struct containing details for the shared report
Returned Fields:
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
Add New Note User Contributed Notes for campaignShareReport
No notes, yet... Will you be the first??