OneCall API User Manual
Contents
1. segment scope VISIT lt name gt Referral_visits lt name gt lt id gt 23 lt id gt lt folder gt personal lt folder gt lt segment gt lt segment list gt 2 8 Visit Filter id command visitfilterid description Return the id of a visit filter that is specified by the folder and the name format Value Description C comScore The output format is XML pretty_xml The XML output is piped through xmllint to make it human readable CSV The output format is in CSV format json The output format is in json format Mandatory Value Description client The client name user The user name password The password of the user visitfilterfolder The folder where the visit filter is located cgi args visitfiltername The name of the visit filter Optional Value Description format The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification Credits This command uses 0 credits Example https sitestatapi com v1 visitfilterid xml client example amp visitfilterfolder personal amp visitfiltername Engage d_visitors amp format csv amp user john amp password secret The output Folder Name personal Engaged_visitors 287 Example https sitestatapi com v1 visitfilterid json client example amp visitfilterfolder personal amp visitfiltername2. 1 1 Syntax The syntax of the request is https sitestatapi com version command format cgi args version v1 command data you want to request format CSV XML Pretty_XML json An example of a request is https sitestatapi com v1 reportitems csv itemid 63 amp startdate yesterday amp site nl amp client nedstat amp maxlin es 8 amp segmentfolder personal amp segmentname Adwords visitors amp user john amp password secret All commands are described in chapter two of this manual 1 2 Credit model A credit is the cost of an call to the server Making an call costs 1 credit per report item per reporting period of 1 day Credits are calculated for the amount of data being processed and not for the output which can be one number Only the command reportitems uses credits Example one call for 3 report items over the past seven days will cost 3 items 7 days 21 credits The OneCall is part of the Digital Analytix subscription It includes 500 free credits per rolling window of 24 hours per client not per site This means that if the first credit was used at 11 00 am the user has 499 free credits left until 11 00 am the next day To see how many credits remain use the command credits described in chapter 2 7 If you run out of credits during the course of the rolling 24 hours an error message will be returned You can purchase additional credits by contacting your Account Manager
3. Engag ed_visitors amp user john amp password secret The output segment scope VISIT name Engaged_visitors folder personal id 287 comScore Or https sitestatapi com v1 visitfilterid pretty_xml client example amp visitfilterfolder personal amp visitfiltername Engaged_visitors amp user john amp password secret The output lt xml version 1 0 encoding UTF 8 gt segment scope VISIT gt lt name gt Engaged_visitors lt name gt lt id gt 287 lt id gt lt folder gt personal lt folder gt lt segment gt 2 9 Site list command sitelist description List all sites for a given corporate Value Description xml The output format is XML format pretty xml The XML output is piped through xmllint to make it human readable CSV The output format is in CSV format json The output format is in json format Mandatory Value Description client The name of the client user The name of the user password The password of the user cgi args Optional Value Description format The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification C comScore Credits This command uses 0 credits Example https sitestatapi com v1 sitelist pretty_xml client example amp user john amp password secr
4. To return report item with a segment applied in XML format https sitestatapi com v1 reportitems pretty_xml itemid 1 amp startdate 20080801 amp enddate 20080803 amp sit e examplecom amp clientzexample amp user john amp password secret amp segmentid 2 C comScore The output lt xml version 1 0 encoding UTF 8 gt lt reportitems count 1 gt lt reportitem gt lt title gt Total page views lt title gt lt columns count 2 gt lt column gt lt ctitle gt Date lt ctitle gt lt type gt date lt type gt lt alignment gt left lt alignment gt lt column gt lt column gt lt ctitle gt Page views lt ctitle gt lt type gt integer lt type gt lt alignment gt right lt alignment gt lt column gt lt columns gt lt rows count 3 gt n c 01 08 2008 c lt gt 40 lt gt Ir n lt gt 02 08 2008 lt gt lt gt 53 lt gt Ir n lt c gt 03 08 2008 lt c gt lt C gt 32 lt c gt Ir lt rows gt lt statistics gt lt total gt lt gt lt gt 125 lt gt lt total gt lt average gt lt gt lt gt 41 66666666666666 lt gt lt gt lt minimum gt lt gt lt gt 32 lt gt lt minimum gt lt maximum gt lt gt lt gt 53 lt gt lt maximum gt lt statistics gt lt reportitem gt lt reportitems gt comScore apply an event filter or visit fil
5. command lists all the visit filters that have been created in Digital Analytix description The output includes the name and the numeric id that can be used in the reportitems command Value Description xml The output format is XML format pretty xml The XML output is piped through xmllint to make it human readable CSV The output format is in CSV format json The output format is in json format Mandatory Value Description client The client name user The user name cgi args password The password of the user Optional Value Description C comScore The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification visitfilterfolder Limit the output to the specified folder type The possible types are personal standard or shared The default is to list all folder types Credits This command uses 0 credits Example https sitestatapi com v1 visitfilterlist xml client example amp user john amp password secret The output lt xml version 1 0 encoding UTF 8 gt segment list count 23 gt segment scope VISIT lt name gt All_ visits lt name gt lt id gt 1 lt id gt lt folder gt standard lt folder gt lt segment gt segment scope VISIT lt name gt Campaign_visits lt name gt lt id gt 5 lt id gt lt folder gt personal lt folder gt lt segment gt
6. 01 amp enddate 201 0093 0 amp visitfilterid 110 amp maxlines 7 amp nrofrows 6 amp parameter s value Example To apply a regular expression to a parameter value indicating where to use two characters https sitestatapi com v1 reportitems xml client name amp user john amp password secret amp itemid 69 amp site ex ample amp startdate 20100901 amp enddate 20100930 amp parameters key1 value1 key2 regexp 4 value21 v alue22 value23 key3 value3 C comScore 2 11 Credits command description format cgi args Credits Example credits List the remaining credits Value xml pretty xml csv json Mandatory Value client user password site Optional Value format Description The output format is XML The XML output is piped through xmllint to make it human readable The output format is in CSV format The output format is in json format Description The client name The user name The password of the user The name of the site Description The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification This command uses 0 credits https sitestatapi com v1 credits pretty xml clientzexample amp user john amp password secret C comScore The output lt xml version 1 0 encoding UTF 8 gt lt cr
7. GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU INDONESIA IRAN ISLAMIC REPUBLIC OF IRAQ IRELAND ISLE OF MAN ISRAEL ITALY J JAMAICA JAPAN JERSEY JORDAN K KAZAKHSTAN KENYA KOREA DEMOCRATIC PEOPLE S REPUBLIC OF KOREA REPUBLIC OF KUWAIT KYRGYZSTAN L LAO PEOPLE S DEMOCRATIC REPUBLIC LATVIA LEBANON LESOTHO LIBERIA LIBYAN ARAB JAMAHIRIYA LIECHTENSTEIN LITHUANIA LUXEMBOURG M MACAO MACEDONIA THE FORMER YUGOSLAV REPUBLIC OF MADAGASCAR MALAWI MALAYSIA MALDIVES MALI MALTA MARSHALL ISLANDS MARTINIQUE MAURITANIA MAURITIUS MAYOTTE comScore JM JP JE JO KZ KE KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MICRONESIA FEDERATED STATES OF MOLDOVA REPUBLIC OF MONACO MONGOLIA MONTENEGRO MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR N NAMIBIA NAURU NEPAL NETHERLANDS NETHERLANDS ANTILLES NEW CALEDONIA NEW ZEALAND NICARAGUA NIGER NIGERIA NIUE NORFOLK ISLAND NORTHERN MARIANA ISLANDS NORWAY PAKISTAN PALAU PALESTINIAN TERRITORY OCCUPIED PANAMA PAPUA NEW GUINEA PARAGUAY PERU PHILIPPINES PITCAIRN POLAND PORTUGAL PUERTO RICO Q QATAR R REUNION comScore MX FM MD MC MN ME MS MA MZ MM NA NR NP NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN P
8. If you have any questions please do not hesitate to contact comScore Customer Support at 1 866 276 6972 C comSconE 2 2 1 Report item list command description format cgi args Credits Example reportitemlist The reportitemlist command lists all the report items The output includes the numeric id that can be used in the reportitems command The output also contains the position in the item tree in Digital Analytix Value xml csv pretty_xml json Mandatory Value client user password Optional Value format Description The output format is XML The output format is csv The XML output is piped through xmllint to make it human readable The output format is in json format Description The client name The user name The password of the user Description The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification This command uses 0 credits https sitestatapi com v1 reportitemlist xml client example amp user john amp password secret comScore The output lt xml version 1 0 encoding UTF 8 gt lt reportitemlist count 254 gt lt ri gt lt id gt 53 lt id gt lt path gt All Visitors General Total visitors lt path gt lt ri gt lt id gt 224 lt id gt lt path gt All Visitors General Unique v
9. L PT PR QA RE ROMANIA RO RUSSIAN FEDERATION RU RWANDA RW 5 SAINT BARTHELEMY BL SAINT HELENA SH SAINT KITTS AND NEVIS KN SAINT LUCIA LC SAINT MARTIN MF SAINT PIERRE AND MIQUELON PM SAINT VINCENT AND THE GRENADINES VC SAMOA WS SAN MARINO SM SAO TOME AND PRINCIPE ST SAUDI ARABIA SA SENEGAL SN SERBIA RS SEYCHELLES SC SIERRA LEONE SL SINGAPORE SG SLOVAKIA SK SLOVENIA SI SOLOMON ISLANDS SB SOMALIA SO SOUTH AFRICA ZA SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS GS SPAIN ES SRI LANKA LK SUDAN SD SURINAME SR SVALBARD AND JAN MAYEN SJ SWAZILAND SZ SWEDEN SE SWITZERLAND CH SYRIAN ARAB REPUBLIC SY T TAIWAN PROVINCE OF CHINA TW TAJIKISTAN TJ TANZANIA UNITED REPUBLIC OF TZ THAILAND TH TIMOR LESTE TL TOGO TG TOKELAU TK TONGA TO C comScore TRINIDAD AND TOBAGO TUNISIA TURKEY TURKMENISTAN TURKS AND CAICOS ISLANDS TUVALU U UGANDA UKRAINE UNITED ARAB EMIRATES UNITED KINGDOM UNITED STATES UNITED STATES MINOR OUTLYING ISLANDS URUGUAY UZBEKISTAN V VANUATU VATICAN CITY STATE VENEZUELA BOLIVARIAN REPUBLIC OF VIET NAM VIRGIN ISLANDS BRITISH VIRGIN ISLANDS U S WALLIS AND FUTUNA WESTERN SAHARA Y YEMEN 2 ZIMBABWE comScore TT TN TR TV UG UA AE GB US UM UY UZ VU see VE VN VG ZM ZW HOLY SEE
10. Measuring the digital world C COMSCORE OneCall API User Manual December 2011 FOR FURTHER INFORMATION PLEASE CONTACT comScore Inc 44 0 20 7841 1540 customersupport comscore com Table of Contents 1 p EET Je2 vereor D 2 1 2 2 tem properes Em RE 2 4 Segment 2 mecs uk uu u dal 10 2 6 EVEN ua 11 2 7 lig N E s 13 2 8 Visit Filter idiin rraian Qala 14 2 9 SIL MIS 16 2410 Repor 18 2 11 Credits a per ere terre erty 23 3 Multiple report items in one request 24 Appendix Country names ALi had el de uui 25 C COMSCORE CONFIDENTIAL v DECEMBER 17 11 PAGE 1 Introduction The OneCall API implements the external access API into the Digital Analytix platform The OneCall API uses the REST protocol and focuses on simplicity simple to request and simple to parse The OneCall API can retrieve report items This includes custom made reports CMR and report items that are created with the Report Builder
11. N BH BANGLADESH BD BARBADOS BB comScore BELARUS BELGIUM BELIZE BENIN BERMUDA BHUTAN BOLIVIA PLURINATIONAL STATE OF BOSNIA AND HERZEGOVINA BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI DARUSSALAM BULGARIA BURKINA FASO BURUNDI CAMBODIA CAMEROON CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHAD CHILE CHINA CHRISTMAS ISLAND COCOS KEELING ISLANDS COLOMBIA COMOROS CONGO CONGO THE DEMOCRATIC REPUBLIC OF THE COOK ISLANDS COSTA RICA COTE D IVOIRE CROATIA CUBA CYPRUS CZECH REPUBLIC D DENMARK DJIBOUTI DOMINICA DOMINICAN REPUBLIC C comScore BY BE BZ BJ BM BT BO BA BW BV BR BN BG BF CM CA CV KY CF TD CL CN CX CC CD CK CR CI HR CU CY CZ DK DJ DM DO ECUADOR EGYPT EL SALVADOR EQUATORIAL GUINEA ERITREA ESTONIA ETHIOPIA F FALKLAND ISLANDS MALVINAS FAROE ISLANDS FIJI FINLAND FRANCE FRENCH GUIANA FRENCH POLYNESIA FRENCH SOUTHERN TERRITORIES G GABON GAMBIA GEORGIA GERMANY GHANA GIBRALTAR GREECE GREENLAND GRENADA GUADELOUPE GUAM GUATEMALA GUERNSEY GUINEA GUINEA BISSAU GUYANA H HAITI HEARD ISLAND AND MCDONALD ISLANDS HOLY SEE VATICAN CITY STATE HONDURAS HONG KONG HUNGARY INDIA comScore EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI
12. code C comScore Description The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification The end date of the reporting period The format is yyyymmad The pseudo dates today yesterday and this month can be used The pseudo dates can also work with an offset For example today 1 is an alias for yesterday Another example would be this month 1 to specify the previous month If not defined the enddate will match the startdate A list of key value pairs key value key value Not optional for some report items The parameter Country is a special case and is used with a two letter acronym see Appendix A When using a regular expression that contains the character use two pipes to separate values Example parameters key1 value1 key2 regexp value21 value22 va lue23 key3 value3 The id of the segment Can be retrieved with segmentid command Note that using the segmentid is significantly faster than using the segmentfolder and segmentname arguments The folder of the segment to apply Note this must be used with the segmentname argument The name of the segment to apply Note this must be used with the segmentfolder argument The start date of the segment period Note this must be used with the segmentenddate argument The end date for the segment period Note th
13. der where the event filter is located cgi args eventfiltername The name of the event filter Optional Value Description format The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification Credits This command uses 0 credits Example https sitestatapi com v1 eventfilterid xml clientzexample amp eventfilterfolder2personal amp eventfiltername En gaged_visitors amp format csv amp user john amp password secret The output Folder Name personal Engaged_visitors 287 Example https sitestatapi com v1 eventfilterid json clientzexample amp eventfilterfolder personal amp eventfiltername E ngaged_visitors amp user john amp password secret comScore The output segment scope EVENT name Engaged_visitors folder personal id 287 Or https sitestatapi com v1 eventfilterid pretty xml clientzexample amp eventfilterfolder2personal amp eventfilterna me Engaged visitors amp user john amp password secret The output lt xml version 1 0 encoding UTF 8 gt lt segment scope EVENT gt lt name gt Engaged_visitors lt name gt lt id gt 287 lt id gt lt folder gt personal lt folder gt lt segment gt 2 7 Visit Filter list command visitfilterlist The visitfilterlist
14. dix A 2 3 Segment list command description format cgi args segmentlist The segmentlist command lists all the segments that have been created in Digital Analytix The output includes the name and the numeric that can be used in the reportitems command Value xml pretty xml CSV json Mandatory Value client user password Optional Value format C COMSCORE Description The output format is XML The XML output is piped through xmllint to make it human readable The output format is in CSV format The output format is in json format Description The client name The user name The password of the user Description The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification segmentfolder Limit the output to the specified folder type The possible types are personal standard or shared The default is to list all folder types Credits This command uses 0 credits Example https sitestatapi com v1 segmentlist xml client example amp user john amp password secret The output lt xml version 1 0 encoding UTF 8 gt segmentlist count 83 gt lt segment scope VISITOR gt lt name gt All_ visitors lt name gt lt id gt 1 lt id gt lt folder gt standard lt folder gt lt segment gt lt segment scope VISITOR gt
15. edits gt lt remaining credits gt 357 lt remaining requests gt lt daily limit gt 500 lt daily limit gt lt reset time gt Mon Jul 20 13 46 17 0200 2009 lt reset time gt lt reset time in seconds gt 85255 lt reset time in seconds gt lt credits gt 3 Multiple report items in one request It is possible to request the output of multiple report items in one request The requests are separated by a double semicolon amp amp The parameters client site user password startdate and enddate are inherited from left to right So if for example for report item number 2 the user name is not specified the user name will be inherited from the specification of report item 1 Please note that only client site user password startdate and enddate are inherited all other settings are not inherited and if not specified will yield the default setting of the report item Example https sitestatapi com v1 reportitems csv user john amp password secret amp itemid 63 amp startdate 20090315 amp enddate 20090321 amp site examplecom amp clientzexample amp parameters Country NL amp maxlines 5 amp nrofrows 4 amp segmentfolder shared amp segmentname Engaged_visitors amp amp itemid 1 amp parameters Country UK amp startd ate 20090312 amp site exampleinfo amp amp itemid 97 amp parameters Country BE amp segmentfolder personal amp segm entname Adwords _visitors amp site exampleinfo The above request results in the following assignment
16. et C comScore The output lt xml version 1 0 encoding UTF 8 gt lt sitelist count 29 gt lt site gt name nl name lt issupersite gt n lt issupersite gt lt site gt lt site gt lt name gt uk lt name gt lt issupersite gt n lt issupersite gt lt site gt lt sitelist gt 2 10 Report items command description format cgi args reportitems Show content of a report item Value xml pretty_xml csv json Mandatory Value client user password site itemid startdate comScore Description The output format is XML The XML output is piped through xmllint to make it human readable The output format is in CSV format The output format is in json format Description The client name The user name The password of the user The name of the site For multiple sites use the character to separate site names example site name1 name2 name3 The id of the report item The start date of the reporting period The format is The pseudo dates today yesterday and this month can be used The pseudo dates can also work with an offset For example today 1 is an alias for yesterday Another example would be this month 1 to specify the previous month Value format enddate parameters segmentid segmentfolder segmentname segmentstartdate segmentenddate Time interval
17. is must be used with the segmentstartdate argument The Digital Analytix time interval code 1 Day 2 Week 3 Month 4 Week day 5 Full period nrofrows The number of output lines for the given report See also maxlines The default is number of lines as specified by the report item maxlines The number of output lines at which the produced report is cut Note that the cutting is applied after the report is generated The default is not to cut the report lang or language The default language is English example lang NL The supported language parameters are English US ENUS English GB ENGB Dutch NL French FR German DE Italian IT Spanish EU ES Spanish Lat Am ESLAT Portuguese Brazil PTBR Credits This command uses 1 credit per day and per site requested The option maximum number of lines in a Digital Analytix report item is the same option as the nrofrows in a OneCallAPI call The option maxlines in a OneCallAPI is the absolute number of lines that will be returned Example To return a single report item with a segment applied in csv format https sitestatapi com v1 reportitems xml itemid 1 amp startdate 20080801 amp enddate 20080803 amp site exam plecom amp formatzcsv amp clientzexample amp user john amp password secret amp segmentid 2 The output Date Page views 01 Aug 2008 40 102 2008 53 103 2008 32
18. isitors lt path gt lt ri gt lt id gt 257 lt id gt lt path gt eCommerce Funnels Time to complete Time overview of first completion per specified funnel lt path gt lt reportitemlist gt 2 2 Report item properties command reportitemproperties Lists all properties for a given report item The properties include e Available Time Intervals e Report item parameters e Name description e Accepts wildcards Type e Enum values Please note that the reportitemparameters command is still valid and available However the reportitemproperties command should be used going forward Value Description xml The output format is XML format pretty xml The XML output is piped through xmllint to make it human readable CSV The output format is csv json The output format is in json format Mandatory cgi args Value Description C comScore The client name user The user name password The password of the user itemid The id of the reportitem that is reported on Optional Value Description The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification Credits This command uses 0 credits Example https sitestatapi com v1 reportitemproperties xml itemid 12 amp client example amp user john amp password secret The output lt
19. lt name gt Adwords _visitors lt name gt lt id gt 5 lt id gt lt folder gt personal lt folder gt lt segment gt lt segment scope VISITOR gt lt name gt Engaged_visitors lt name gt lt id gt 20 lt id gt lt folder gt personal lt folder gt lt segment gt lt segmentlist gt 2 4 Segment id command segmentid description Return the id of a segment that is specified by the folder and the name comScore Value Description xml The output format is XML format pretty_xml The XML output is piped through xmllint to make it human readable CSV The output format is in CSV format json The output format is in json format Mandatory Value Description client The client name user The user name password The password of the user segmentfolder The folder where the segment is located cgi args segmentname The name of the segment Optional Value Description format The output format The format option overrides a possible format as specified in the URL Possible values are limited to the formats as specified in the above format specification Credits This command uses 0 credits Example https sitestatapi com v1 segmentid xml client example amp segmentfolder personal amp segmentname Enga ged_visitors amp format csv amp user john amp password secret The output Folder Name personal Engaged_visitors 287 Example https sitestatapi com v1 segme
20. ntid json client example amp segmentfolder personal amp segmentname Enga ged_visitors amp user john amp password secret comScore The output segment scope VISITOR name Engaged_visitors folder personal id 287 or https sitestatapi com v1 segmentid pretty_xml client example amp segmentfolder personal amp segmentname Engaged_visitors amp user john amp password secret The output lt xml version 1 0 encoding UTF 8 gt lt segment scope VISITOR gt lt name gt Engaged_visitors lt name gt lt id gt 287 lt id gt lt folder gt personal lt folder gt lt segment gt 2 5 Event Filter list command eventtilterlist The eventfilterlist command lists all the event filters that have been created in Digital description Analytix The output includes the name and the numeric id that can be used in the reportitems command Value Description xml The output format is XML format pretty xml The XML output is piped through xmllint to make it human readable CSV The output format is in CSV format json The output format is in json format Mandatory Value Description client The client name user The user name cgi args password The password of the user Optional Value Description format The output format The format option overrides a possible comScore format as specified in the URL Possible values are limited to the formats a
21. s for the 3 three requests 1st request 2nd request 3rd request reportitem 63 1 97 user john Inherited from 181 request john Inherited from 2nd request john Inherited from 1st request secret Inherited from 2nd request secret Inherited from 2nd request startdate 20090315 20090312 20090312 Inherited from 1st request Inherited from 2nd request oe arcs 20090321 20090321 site examplecom exampleinfo exampleinfo client example Inherited from 1st request Inherited from 2nd request C comScore example parameters Country NL Country UK Country BE maxlines 5 Default set by report item Default set by report item nrofrows 4 All output rows All output rows folder shared personal segment Engaged visitors Adwords_ visitors Will only be used from the 1st report item Values in other requests will be ignored Please note that making an API call costs 1 credit per report item per reporting period of 1 day Credits are calculated for the amount of data being processed and not for the output see also chapter 1 2 Credit model described on page 3 of this manual Appendix A Country names Country names ISO 3166 1 alpha 2 code A AFGHANISTAN AF LAND ISLANDS AX ALBANIA AL ALGERIA DZ AMERICAN SAMOA AS ANDORRA AD ANGOLA AO ANGUILLA ANTIGUA AND BARBUDA AG ARGENTINA AR ARMENIA AM ARUBA AW AUSTRALIA AU AUSTRIA AT AZERBAIJAN AZ B BAHAMAS BS BAHRAI
22. s specified in the above format specification Limit the output to the specified folder type The possible types eventfilterfolder are personal standard or shared The default is to list all folder types Credits This command uses 0 credits Example https sitestatapi com v1 eventfilterlist xml client example amp user john amp password secret The output lt xml version 1 0 encoding UTF 8 gt lt segment list count 23 gt lt segment scope EVENT gt lt name gt All_ events lt name gt id 1 id lt folder gt standard lt folder gt lt segment gt lt segment scope EVENT gt lt name gt entry_events lt name gt lt id gt 5 lt id gt lt folder gt personal lt folder gt lt segment gt lt segment scope EVENT gt lt name gt campaign_events lt name gt lt id gt 23 lt id gt lt folder gt personal lt folder gt lt segment gt lt segment list gt 2 6 Event Filter id command description Return the id of event filter that is specified by the folder and the C comScore Description xml The output format is XML format pretty_xml The XML output is piped through xmllint to make it human readable CSV The output format is in CSV format json The output format is in json format Mandatory Value Description client The client name user The user name password The password of the user eventfilterfolder The fol
23. ter to report item add the event filter or visit filter ID to the API string https sitestatapi com v1 reportitems xml client name amp user john amp password secret amp itemid 69 amp site ex ample amp startdate 20100901 amp enddate 201 00930 amp visitfilterid 1 10 or https sitestatapi com v1 reportitems xml client name amp user john amp password secret amp itemid 69 amp site ex ample amp startdate 20100901 amp enddate 20100930 amp eventtfilterid 94 Example To apply a segment to a report item with a segment period that is different from the report period https sitestatapi com v1 reportitems xml client name amp user john amp password secret amp itemid 69 amp site ex ample amp startdate 20100908 amp enddate 20100914 amp segmentid 70 amp segmentstartdate 20100830 amp segm entenddate 20100905 Or using segment folder and segment name instead of segment ID https sitestatapi com v1 reportitems xml client name amp user john amp password secret amp itemid 69 amp site ex ample amp startdate 20100908 amp enddate 20100914 amp segmentfolder personal amp segmentname natural_s earch amp segmentstartdate 20100830 amp segmentenddate 20100905 Example To apply a visit filter to a report item with a parameter maximum number of lines and specific number of rows https sitestatapi com v1 reportitems xml client name amp user john amp password secret amp itemid 69 amp site ex ample amp startdate 201009
24. xml version 1 0 encoding UTF 8 gt lt reportitemproperties gt lt timeintervalcodes count 5 gt lt timeintervalcode id 1 gt day lt timeintervalcode gt lt timeintervalcode id 2 gt week lt timeintervalcode gt lt timeintervalcode id 3 gt month lt timeintervalcode gt lt timeintervalcode id 4 gt weekday lt timeintervalcode gt lt timeintervalcode id 5 gt full_ period lt timeintervalcode gt lt timeintervalcodes gt reportltemparameters count 4 gt lt reportitemparameter gt lt name gt Channel lt name gt lt acceptwildcards gt y lt acceptwildcards gt lt type gt string lt type gt lt reportitemparameter gt lt reportitemparameter gt lt name gt Source lt name gt lt acceptwildcards gt y lt acceptwildcards gt lt type gt string lt type gt lt reportitemparameter gt lt reportitemparameter gt comScore lt name gt Conversion lt gt lt acceptwildcards gt y lt acceptwildcards gt lt type gt countername lt type gt lt reportitemparameter gt lt reportitemparameter gt lt name gt Attribution to lt name gt lt acceptwildcards gt n lt acceptwildcards gt lt type gt enum lt type gt lt enumvalues gt first source in channel last source in channel lt enumvalues gt lt reportitemparameter gt lt reportltemparameters gt lt reportitemproperties gt The parameter Couniry is a special case It is specified as a two letter acronym see Appen
Download Pdf Manuals
Related Search