{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/2016/reports/dimensions","auth":"required","settings":"5eb0433271fd4503c0318dd8","results":{"codes":[{"name":"","code":"[\n  {\n    \"apiKey\": \"sub_network_name\",\n    \"name\": \"Sub Network Name\",\n    \"description\": \"Sub Network associated with this delivery data\"\n  },\n  {\n    \"apiKey\": \"sub_network_id\",\n    \"name\": \"Snid\",\n    \"description\": \"Sub Network ID associated with this delivery data\"\n  },\n  {\n    \"apiKey\": \"campaign_start_date\",\n    \"name\": \"Campaign Start Date\",\n    \"description\": \"Start date of the campaign in US Eastern time\"\n  },\n  {\n    \"apiKey\": \"campaign_end_date\",\n    \"name\": \"Campaign End Date\",\n    \"description\": \"End date of the campaign in US Eastern time\"\n  },\n  {\n    \"apiKey\": \"vertical\",\n    \"name\": \"Vertical\",\n    \"description\": \"Vertical Industry of the product being advertised by the campaign\"\n  },\n  {\n    \"apiKey\": \"salesforce_id\",\n    \"name\": \"Salesforce Id\",\n    \"description\": \"Salesforce ID\"\n  },\n  {\n    \"apiKey\": \"browser\",\n    \"name\": \"Browser\",\n    \"description\": \"Browser on which ad was displayed\"\n  },\n  {\n    \"apiKey\": \"delivery_channel\",\n    \"name\": \"Delivery Channel\",\n    \"description\": \"Delivery channel on which ad was displayed\"\n  },\n  {\n    \"apiKey\": \"operating_system\",\n    \"name\": \"Operating System\",\n    \"description\": \"Operating System on which ad was displayed\"\n  },\n  {\n    \"apiKey\": \"device\",\n    \"name\": \"Device\",\n    \"description\": \"Device on which ad was displayed\"\n  },\n  {\n    \"apiKey\": \"advertiser_name\",\n    \"name\": \"Advertiser Name\",\n    \"description\": \"Name of the Advertiser (definer) associated with this campaign\"\n  },\n  {\n    \"apiKey\": \"advertiser_id\",\n    \"name\": \"Aid\",\n    \"description\": \"Advertiser ID, aka definer_id in our system\"\n  },\n  {\n    \"apiKey\": \"account_manager\",\n    \"name\": \"Account Manager\",\n    \"description\": \"Account manager responsible for this campaign\"\n  },\n  {\n    \"apiKey\": \"ops_manager\",\n    \"name\": \"Ops Manager\",\n    \"description\": \"Ops manager responsible for this campaign\"\n  },\n  {\n    \"apiKey\": \"analyst\",\n    \"name\": \"Analyst\",\n    \"description\": \"Analyst responsible for this campaign\"\n  },\n  {\n    \"apiKey\": \"priority\",\n    \"name\": \"Priority\",\n    \"description\": \"Campaign priority\"\n  },\n  {\n    \"apiKey\": \"last_updated\",\n    \"name\": \"Last Updated\",\n    \"description\": \"Last updated\"\n  },\n  {\n    \"apiKey\": \"last_rating\",\n    \"name\": \"Last Rating\",\n    \"description\": \"Customer happiness rating\"\n  },\n  {\n    \"apiKey\": \"last_rated_at\",\n    \"name\": \"Last Rated At\",\n    \"description\": \"Customer happiness rated at\"\n  },\n  {\n    \"apiKey\": \"region\",\n    \"name\": \"Region\",\n    \"description\": \"Region of account executive\"\n  },\n  {\n    \"apiKey\": \"billing_source\",\n    \"name\": \"Billing Source\",\n    \"description\": \"First or Third Party whose reports are used for official billing\"\n  },\n  {\n    \"apiKey\": \"billing_type\",\n    \"name\": \"Billing Type\",\n    \"description\": \"Method used to bill customers\"\n  },\n  {\n    \"apiKey\": \"salesperson1\",\n    \"name\": \"Salesperson 1\",\n    \"description\": \"Primary salesperson responsible for this campaign\"\n  },\n  {\n    \"apiKey\": \"salesperson2\",\n    \"name\": \"Salesperson 2\",\n    \"description\": \"Secondary salesperson responsible for this campaign\"\n  },\n  {\n    \"apiKey\": \"agency_name\",\n    \"name\": \"Agency Name\",\n    \"description\": \"The agency who bought this campaign from us on behalf of an advertiser\"\n  },\n  {\n    \"apiKey\": \"agency_id\",\n    \"name\": \"Agency Id\",\n    \"description\": \"ID of the agency who bought this campaign on behalf of an advertiser\"\n  },\n  {\n    \"apiKey\": \"campaign_name\",\n    \"name\": \"Campaign Name\",\n    \"description\": \"Campaign Name\"\n  },\n  {\n    \"apiKey\": \"service_type\",\n    \"name\": \"Service Type\",\n    \"description\": \"The level of service that Rocket Fuel provided. Campaigns on the same subnetwork will generally have the same Service Type, but Service Type can be overriden at the campaign level.\"\n  },\n  {\n    \"apiKey\": \"campaign_currency\",\n    \"name\": \"Campaign Currency\",\n    \"description\": \"Campaign Currency\"\n  },\n  {\n    \"apiKey\": \"campaign_id\",\n    \"name\": \"Cid\",\n    \"description\": \"Campaign ID\"\n  },\n  {\n    \"apiKey\": \"line_item_name\",\n    \"name\": \"Line Item Name\",\n    \"description\": \"Line Item - a billable unit of reporting within a Campaign\"\n  },\n  {\n    \"apiKey\": \"advertisement_id\",\n    \"name\": \"Advertisement Id\",\n    \"description\": \"ID of Ad (Creative) Which Was Served.\"\n  },\n  {\n    \"apiKey\": \"line_item_id\",\n    \"name\": \"Li Id\",\n    \"description\": \"Line Item ID - a billable unit of reporting within a Campaign\"\n  },\n  {\n    \"apiKey\": \"rf_io_id\",\n    \"name\": \"Rf Io Id\",\n    \"description\": \"Rocket Fuel Insertion Order number\"\n  },\n  {\n    \"apiKey\": \"agency_fee_percentage\",\n    \"name\": \"Agency Fee %\",\n    \"description\": \"Agency Fee % from related Insertion Order\"\n  },\n  {\n    \"apiKey\": \"pricing_type\",\n    \"name\": \"Pricing Type\",\n    \"description\": \"Pricing method used to bill customers\"\n  },\n  {\n    \"apiKey\": \"last_pricing_value\",\n    \"name\": \"Last Pricing Value\",\n    \"description\": \"Most recent Pricing Value in local campaign currency for the corresponding Pricing Type (used to bill customers). This dimension only shows the most recent value and does not capture any prior values if the value has been changed.\"\n  },\n  {\n    \"apiKey\": \"tactic_name\",\n    \"name\": \"Tactic Name\",\n    \"description\": \"Tactic - an internal subunit of a Line Item used to manually try different strategies to optimize the performance or delivery of the Line Item\"\n  },\n  {\n    \"apiKey\": \"tactic_id\",\n    \"name\": \"Tid\",\n    \"description\": \"Tactic ID - an internal subunit of a Line Item used to manually try different strategies to optimize the performance or delivery of the Line Item\"\n  },\n  {\n    \"apiKey\": \"flight_name\",\n    \"name\": \"Flight Name\",\n    \"description\": \"Flight - a distinct time segment of campaign delivery with start + end dates\"\n  },\n  {\n    \"apiKey\": \"flight_id\",\n    \"name\": \"Fid\",\n    \"description\": \"Flight ID - a distinct time segment of campaign delivery with start + end dates\"\n  },\n  {\n    \"apiKey\": \"flight_start_date\",\n    \"name\": \"Flight Start Date\",\n    \"description\": \"Start date of flight\"\n  },\n  {\n    \"apiKey\": \"flight_end_date\",\n    \"name\": \"Flight End Date\",\n    \"description\": \"End date of flight\"\n  },\n  {\n    \"apiKey\": \"year\",\n    \"name\": \"Year\",\n    \"description\": \"Year in which these impressions were served\"\n  },\n  {\n    \"apiKey\": \"quarter\",\n    \"name\": \"Quarter\",\n    \"description\": \"Quarter in which these impressions were served.  To get quarterly data over many years, select both Year and Quarter.\"\n  },\n  {\n    \"apiKey\": \"month\",\n    \"name\": \"Month\",\n    \"description\": \"Month in which these impressions were served.  To get monthly data over many years, select both Year and Month.\"\n  },\n  {\n    \"apiKey\": \"year_and_month\",\n    \"name\": \"Year And Month\",\n    \"description\": \"Year + month in which these impressions were served.\"\n  },\n  {\n    \"apiKey\": \"week\",\n    \"name\": \"Week\",\n    \"description\": \"Week of the year in which these impressions were served.  To get weekly data over many years, select both Year and Week.\"\n  },\n  {\n    \"apiKey\": \"year_and_week\",\n    \"name\": \"Year And Week\",\n    \"description\": \"Year + week in which these impressions were served.\"\n  },\n  {\n    \"apiKey\": \"weekday\",\n    \"name\": \"Weekday\",\n    \"description\": \"Day of the Week on which these impressions were served.\"\n  },\n  {\n    \"apiKey\": \"day_of_month\",\n    \"name\": \"Day Of Month\",\n    \"description\": \"Day of the month on which these impressions were served.  This will group together all impressions served on the 1st day of each month.  To go by individual dates, choose Date instead.\"\n  },\n  {\n    \"apiKey\": \"date\",\n    \"name\": \"Date\",\n    \"description\": \"Date on which these impressions were served.  Choose this for a Daily report.\"\n  },\n  {\n    \"apiKey\": \"hour\",\n    \"name\": \"Hour\",\n    \"description\": \"Hour of the day on which these impressions were served. <b>Only available for the most recent 60 days</b>.  This will group together all impressions served in hour 0, hour 1, etc.  To go by individual hours across multiple days, select both Date and Hour, or else Datetime.\"\n  },\n  {\n    \"apiKey\": \"datetime\",\n    \"name\": \"Datetime\",\n    \"description\": \"Date and time on which impressions were served, to granularity of 1 hour.  <b>Only available for the most recent 60 days.</b>\"\n  },\n  {\n    \"apiKey\": \"publisher_name\",\n    \"name\": \"Publisher Name\",\n    \"description\": \"Publisher (exchange) on which these ads were served.\"\n  },\n  {\n    \"apiKey\": \"placement\",\n    \"name\": \"Placement\",\n    \"description\": \"Placement (within each Publisher) on which these ads were served.  Incorporates the ad size, and sometimes other descriptive characteristics of the traffic, e.g. if a direct buy was done for a particular purpose.\"\n  },\n  {\n    \"apiKey\": \"advertisement_name\",\n    \"name\": \"Advertisement Name\",\n    \"description\": \"Ad (Creative) which was served.\"\n  },\n  {\n    \"apiKey\": \"ad_size\",\n    \"name\": \"Ad Size\",\n    \"description\": \"Size of the ad that was served.  This may group together many ads that were the same size.\"\n  },\n  {\n    \"apiKey\": \"advertisement_type\",\n    \"name\": \"Advertisement Type\",\n    \"description\": \"Type of the ad that was served -- Text(0), Html(1), ImageBanner(2), Flash(3), VastVideo(4), Facebook(5), FacebookPPA(6), Instagram(7), FacebookVideo(8), Native(9).\"\n  },\n  {\n    \"apiKey\": \"media_format\",\n    \"name\": \"Media Format\",\n    \"description\": \"Media Format of the ad that was served -- Display(0), Video(1), Native(2).\"\n  },\n  {\n    \"apiKey\": \"thirdparty_ad_id\",\n    \"name\": \"Thirdparty Ad Id\",\n    \"description\": \"Size of the ad that was served.  This may group together many ads that were the same size.\"\n  },\n  {\n    \"apiKey\": \"media_type\",\n    \"name\": \"Media Type\",\n    \"description\": \"Media Type that was served -- Display Media, Ad Effectiveness Survey (test or control), Targeting Effectiveness Survey are different media types. -- All(0), Regular(1), SurveyTE(2), SurveyAEControl(3), SurveyAEExposed(4), Bonus(5), BonusCommitted(6), Control(7).\"\n  },\n  {\n    \"apiKey\": \"tier\",\n    \"name\": \"Tier\",\n    \"description\": \"Tier in which these impressions were served. This can be Normal or Tier 2, which means the impression opportunity was rejected by our adserver for reasons of impression quality that we determined after the bid request was made.\"\n  },\n  {\n    \"apiKey\": \"impressions_source\",\n    \"name\": \"Impressions Source\",\n    \"description\": \"Source of the data for the counts of these impressions; internal, estimated, or accurately loaded from external reports e.g. from Ad-juster or DART or Atlas.\"\n  },\n  {\n    \"apiKey\": \"clicks_source\",\n    \"name\": \"Clicks Source\",\n    \"description\": \"Source of the data for the count of clicks; internal, estimated, or accurately loaded from external reports e.g. from Ad-juster or DART or Atlas.\"\n  },\n  {\n    \"apiKey\": \"impression_day_conversion_source\",\n    \"name\": \"Impression Day Conversion Source\",\n    \"description\": \"Source of the data for the count of conversions; internal, estimated, or accurately loaded from external reports e.g. from Ad-juster or DART or Atlas.\"\n  },\n  {\n    \"apiKey\": \"conversion_source\",\n    \"name\": \"Conversion Source\",\n    \"description\": \"Source of the data for the count of thisday_conversions; internal, estimated, or accurately loaded from external reports e.g. from Ad-juster or DART or Atlas.\"\n  },\n  {\n    \"apiKey\": \"impression_day_cross_device_conversion_source\",\n    \"name\": \"Impression Day Cross-device Conversion Source\",\n    \"description\": \"Source of the data for the count of cross-device conversions; internal, estimated, or accurately loaded from external reports e.g. from Ad-juster or DART or Atlas.\"\n  },\n  {\n    \"apiKey\": \"cross_device_conversion_source\",\n    \"name\": \"Cross-device Conversion Source\",\n    \"description\": \"Source of the data for the count of cross-device thisday conversions; internal, estimated, or accurately loaded from external reports e.g. from Ad-juster or DART or Atlas.\"\n  },\n  {\n    \"apiKey\": \"cost_source\",\n    \"name\": \"Cost Source\",\n    \"description\": \"Source of the data for our costs; internal, estimated, or accurately loaded from external reports e.g. from Ad-juster or DART or Atlas.\"\n  },\n  {\n    \"apiKey\": \"fbx_title\",\n    \"name\": \"FBX Title\",\n    \"description\": \"Title of the FBX ad shown.  Only available for FBX campaigns.\"\n  },\n  {\n    \"apiKey\": \"fbx_body\",\n    \"name\": \"FBX Body\",\n    \"description\": \"Body text of the FBX ad shown.  Only available for FBX campaigns.\"\n  },\n  {\n    \"apiKey\": \"fbx_image\",\n    \"name\": \"FBX Image\",\n    \"description\": \"Filename of the image shown in the FBX ad.  Only available for FBX campaigns.\"\n  },\n  {\n    \"apiKey\": \"fbx_link\",\n    \"name\": \"FBX Link\",\n    \"description\": \"Landing URL link shown in the FBX ad.  Only available for FBX campaigns.\"\n  },\n  {\n    \"apiKey\": \"fbx_caption\",\n    \"name\": \"FBX Caption\",\n    \"description\": \"Caption of the FBX PPA ad shown.  Only available for FBX campaigns showing Page Post ads.\"\n  },\n  {\n    \"apiKey\": \"fbx_message\",\n    \"name\": \"FBX Message\",\n    \"description\": \"Message of the FBX PPA ad shown.  Only available for FBX campaigns showing Page Post ads.\"\n  },\n  {\n    \"apiKey\": \"campaign_time_zone\",\n    \"name\": \"Campaign Time Zone\",\n    \"description\": \"Campaign Time Zone\"\n  },\n  {\n    \"apiKey\": \"rf_integrated_viewability_source\",\n    \"name\": \"Rf Integrated Viewability Source\",\n    \"description\": \"Nature of the data, i.e. Available (as reported by the viewability vendor), Estimated (by Rocket Fuel), Unavailable\"\n  },\n  {\n    \"apiKey\": \"rf_integrated_viewability_vendor\",\n    \"name\": \"Rf Integrated Viewability Vendor\",\n    \"description\": \"Viewability measurement vendor, e.g. comScore, Moat Analytics, RFI (Rocket Fuel)\"\n  },\n  {\n    \"apiKey\": \"adv_reported_viewability_vendor\",\n    \"name\": \"Advertiser-reported Viewability Vendor\",\n    \"description\": \"Viewability measurement vendor, e.g. comScore, Moat Analytics, RFI (Rocket Fuel), as reported by the advertiser\"\n  },\n  {\n    \"apiKey\": \"adv_vb_source\",\n    \"name\": \"Advertiser-reported Viewability Source\",\n    \"description\": \"Nature of the data, i.e. Available (data from a viewability vendor reported to Rocket Fuel by the advertiser), Estimated (by Rocket Fuel), Unavailable.\"\n  },\n  {\n    \"apiKey\": \"in_target_impressions_vendor_source\",\n    \"name\": \"In Target Impressions Source\",\n    \"description\": \"Source of the Metrics (Nielsen: 1, Estimated-Nielsen: 2, Comscore: 3, Estimated-Comscore: 4 ). This is an Audience Guarantee dimension.\"\n  },\n  {\n    \"apiKey\": \"in_target_reach_vendor_source\",\n    \"name\": \"In Target Impressions Source For Reach\",\n    \"description\": \"Source of the Metrics (Nielsen: 1, Comscore: 3). This is an AG Campaign Reach dimension.\"\n  }\n]","language":"json","status":200}]},"params":[{"name":"Accept","type":"string","default":"application/json","desc":"Specify mediatype for the response","required":true,"in":"header","ref":"","_id":"5eb076b07d19ca0171609fa3"},{"name":"x-auth-token","type":"string","default":"","desc":"Token for API access (sandbox/production)","required":true,"in":"header","ref":"","_id":"5eb076b07d19ca0171609fa2"},{"name":"X-API-Version","type":"int","default":"","desc":"Version number for the API for a given resource.","required":true,"in":"header","ref":"","_id":"5eb2c211f2ed49001e880573"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Return a list of reporting dimensions allowed for the current user","type":"endpoint","slug":"return-a-list-of-reporting-dimensions-allowed-for-the-current-user","excerpt":"","body":"","updates":[],"order":36,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5eb2db15863f550560c970d0","createdAt":"2020-05-06T15:43:17.332Z","user":"5eb01f8e661699003c0d571b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Zeta DSP API","slug":"dsp-api","order":14,"from_sync":false,"reference":false,"_id":"5ea811617bf4b5007328a0af","createdAt":"2020-04-28T11:20:01.502Z","version":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","__v":0},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221","5a8f4797a44f8600128e75ee","5bbf8833eb416300039a2c14","5ea811617bf4b5007328a0af"],"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","releaseDate":"2016-02-01T23:55:56.544Z","__v":34,"createdAt":"2016-02-01T23:55:56.544Z"},"project":"56aff08c3a5b810d00745d99","__v":0,"parentDoc":null}

getReturn a list of reporting dimensions allowed for the current user


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Headers

Accept:
required
stringapplication/json
Specify mediatype for the response
x-auth-token:
required
string
Token for API access (sandbox/production)
X-API-Version:
required
integer
Version number for the API for a given resource.

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}