{"id":24251,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/getreports-1\/"},"modified":"2025-02-24T09:26:06","modified_gmt":"2025-02-24T17:26:06","slug":"getreports-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/","title":{"rendered":"get_reports"},"content":{"rendered":"

This function retrieves a list of available reports for a given user.<\/p>\n

\n\tSYNTAX<\/h3>\n

http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action?
\n\tuser_id=username
\n\t&password=password <\/span><\/span>OR <\/span>[&access_token=token-value]
\n\t&statevar=get_reports<\/span><\/p>\n

\n\tNOTES<\/h3>\n

The delimiter \u2018:\u2019 in the example is the system delimiter stored in the behavior setting named DEFAULT_TEXT_REPORT_DELIMITER.<\/p>\n

The typical use of this command is to retrieve a list of available shared and private reports, to present these as a menu and allow the user to select which report he is going to run with the run_report function.<\/p>\n

There are two main sections returned, a list of <\/span>private:<\/strong> <\/span>and a list of <\/span>public:<\/strong> <\/span>reports<\/p>\n

The optional access_token<\/code> parameter allows you to use a valid OAuth2 token obtained with the get_token<\/code> command.  If you provide the access_token<\/code> parameter, then the user_id<\/code> and password<\/code> parameters should not be provided.  This prevents the password being sent in clear text over your network connection.<\/p>\n

Within each of these sections, each report is shown with four values, separated by the DEFAULT_TEXT_REPORT_DELIMITER and specified as:<\/p>\n

1. Report ID \u2013 a numeric identifier for the report<\/p>\n

2. Title \u2013 the title of the report<\/p>\n

3. Type \u2013 One of the following types:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n\t\t\t\tType<\/td>\n\n\t\t\t\tPurpose<\/td>\n<\/tr>\n
\n\t\t\t\tADMIN_REPORT<\/td>\n\n\t\t\t\tAdmin Report<\/td>\n<\/tr>\n
\n\t\t\t\tADVANCED<\/td>\n\n\t\t\t\tColumn report with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tAGING<\/td>\n\n\t\t\t\tAging reports with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tAGING_ADV<\/td>\n\n\t\t\t\tAging reports with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tCALENDAR<\/td>\n\n\t\t\t\tCalendar report with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tCALENDAR_ADV<\/td>\n\n\t\t\t\tCalendar report with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tCHART<\/td>\n\n\t\t\t\tCharts with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tCHART_ADV<\/td>\n\n\t\t\t\tCharts with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tCONTAINER<\/td>\n\n\t\t\t\tContainer reports<\/td>\n<\/tr>\n
\n\t\t\t\tCUSTOMURL<\/td>\n\n\t\t\t\tCustom URL report with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tCUSTOMURL_ADV<\/td>\n\n\t\t\t\tCustom URL report with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tDASHBOARD<\/td>\n\n\t\t\t\tDashboard report<\/td>\n<\/tr>\n
\n\t\t\t\tDETAILED<\/td>\n\n\t\t\t\tDetailed reports<\/td>\n<\/tr>\n
\n\t\t\t\tGEOSPATIAL<\/td>\n\n\t\t\t\tGeospatial reports with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tGEOSPATIAL_ADV<\/td>\n\n\t\t\t\tGeospatial reports with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tMATRIX<\/td>\n\n\t\t\t\tMatrix report with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tMATRIX_ADV<\/td>\n\n\t\t\t\tMatrix report with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tPAGE_LAYOUT_CHR<\/td>\n\n\t\t\t\tPage Layout chart<\/td>\n<\/tr>\n
\n\t\t\t\tPAGE_LAYOUT_COL<\/td>\n\n\t\t\t\tPage Layout Column report<\/td>\n<\/tr>\n
\n\t\t\t\tPAGE_LAYOUT_DGB<\/td>\n\n\t\t\t\tPage Layout Double Group By report<\/td>\n<\/tr>\n
\n\t\t\t\tPAGE_LAYOUT_SGB<\/td>\n\n\t\t\t\tPage Layout Single Group By report<\/td>\n<\/tr>\n
\n\t\t\t\tPLANNING_ADV<\/td>\n\n\t\t\t\tPlanning report with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tQUICKLIST<\/td>\n\n\t\t\t\tQuickList reports<\/td>\n<\/tr>\n
\n\t\t\t\tSTANDARD<\/td>\n\n\t\t\t\tColumn reports with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tSUMMARY<\/td>\n\n\t\t\t\tSummary reports with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tSUMMARY_ADV<\/td>\n\n\t\t\t\tSummary reports with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tTASKBOARD<\/td>\n\n\t\t\t\tTaskboard reports with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tTASKBOARD_ADV<\/td>\n\n\t\t\t\tTaskboard reports with advanced filters<\/td>\n<\/tr>\n
\n\t\t\t\tTREEGRID<\/td>\n\n\t\t\t\tTreegrid reports with standard filters<\/td>\n<\/tr>\n
\n\t\t\t\tTREEGRID_ADV<\/td>\n\n\t\t\t\tTreegrid reports with advanced filters<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Sample return from the get_reports function:<\/p>\n

\n\tprivate:<\/code><\/div>\n
\n\t <\/div>\n
\n\t169:All Features Requests:STANDARD:That are open<\/code><\/div>\n
\n\t <\/div>\n
\n\t94:Bugs I Fixed in January:STANDARD:Bugs not Closed Yet<\/code><\/div>\n
\n\t <\/div>\n
\n\t99:Bugs Open By Month:CHART:For Tracker Enterprise<\/code><\/div>\n
\n\t <\/div>\n
\n\t401:Build<\/code><\/div>\n
\n\t <\/div>\n
\n\t30:STANDARD:Estimated versus Actual Time<\/code><\/div>\n
\n\t <\/div>\n
\n\t89:My Hot Llist:STANDARD:Priority 1 issues that are not closed<\/code><\/div>\n
\n\t <\/div>\n
\n\t73:Open and Fixed Defects:CHART:Year to Date<\/code><\/div>\n
\n\t <\/div>\n
\n\t114:Owners of open bugs:STANDARD:Sorted by owner<\/code><\/div>\n
\n\t <\/div>\n
\n\t119:Report of Open issues:STANDARD:By Bill<\/code><\/div>\n
\n\t <\/div>\n
\n\t109:Status of Bugs Reported:CHART:Over all bugs public:<\/code><\/div>\n
\n\t <\/div>\n
\n\t144:Bug Trend Report:CHART:Open vs. Fixed Issues<\/code><\/div>\n
\n\t <\/div>\n
\n\t391:Bugs:AGING:Aging of all bugs that are not closed<\/code><\/div>\n
\n\t <\/div>\n
\n\t4:Bugs - Assigned to you:SUMMARY:Issues assigned by product<\/code><\/div>\n
\n\t <\/div>\n
\n\t164:Bugs - List of Closed Issues:STANDARD:Ordered by Product<\/code><\/div>\n
\n\t <\/div>\n
\n\t68:Bugs - No Reproducible State:STANDARD:Open Issues<\/code><\/div>\n
\n\t <\/div>\n
\n\t386:Customer Issues:AGING:Aging of all issues<\/code><\/div>\n
\n\t <\/div>\n
\n\t43:Customer Issues:STANDARD:New Issues By Priority<\/code><\/div>\n
\n\t <\/div>\n
\n\t48:Customer Issues:STANDARD:Open Issues By Priority<\/code><\/div>\n
\n\t <\/div>\n
\n\t249:Customer Issues - Time Spent:STANDARD:Items fixed<\/code><\/div>\n
\n\t <\/div>\n
\n\t58:Feature Requests:SUMMARY: Requests By Product and Category<\/code><\/div>\n
\n\t <\/div>\n
\n\t239:Helpdesk Issues:STANDARD:New \/ Open Issues Assigned to Me<\/code><\/div>\n
\n\t <\/div>\n
\n\t234:Helpdesk Issues:ADVANCED:Open Issues<\/code><\/div>\n
\n\t <\/div>\n
\n\t209:Knowledge Base:ADVANCED:Published Articles<\/code><\/div>\n
\n\t <\/div>\n
\n\t214:Knowledge Base:ADVANCED:Unpublished Articles<\/code><\/div>\n
\n\t <\/div>\n
\n\t79:My Open Issues:STANDARD:for Home Page<\/code><\/div>\n
\n\t <\/div>\n
\n\t33:Open P1 Issues:STANDARD:All Areas - Ordered by Assigned To<\/code><\/div>\n
\n\t <\/div>\n
\n\t3:Originated by you:SUMMARY:Issues originated by you<\/code><\/div>\n
\n\t <\/div>\n
\n\t63:QA List - Fixed Defects:STANDARD:Ordered by Priority<\/code><\/div>\n
\n\t <\/div>\n
\n\t84:Summary of All Issues:CHART:Chart of All Statuses<\/code><\/div>\n
\n\t <\/div>\n
\n\t53:Summary of Open Customer Issues:SUMMARY_ADV:By Product<\/code><\/div>\n

 <\/p>\n

\t <\/p>\n","protected":false},"excerpt":{"rendered":"

This function retrieves a list of available reports for a given user. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &statevar=get_reports NOTES The delimiter \u2018:\u2019 in the example is the system delimiter stored in the behavior setting named DEFAULT_TEXT_REPORT_DELIMITER. The typical use of this command is to retrieve a list of available shared and private reports, to present these…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24223,"menu_order":42,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24251","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nget_reports - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"get_reports - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This function retrieves a list of available reports for a given user. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &statevar=get_reports NOTES The delimiter \u2018:\u2019 in the example is the system delimiter stored in the behavior setting named DEFAULT_TEXT_REPORT_DELIMITER. The typical use of this command is to retrieve a list of available shared and private reports, to present these...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-24T17:26:06+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/\",\"name\":\"get_reports - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-24T17:26:06+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Application Programming Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"get_reports\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"get_reports - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/","og_locale":"en_US","og_type":"article","og_title":"get_reports - Product Documentation","og_description":"This function retrieves a list of available reports for a given user. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &statevar=get_reports NOTES The delimiter \u2018:\u2019 in the example is the system delimiter stored in the behavior setting named DEFAULT_TEXT_REPORT_DELIMITER. The typical use of this command is to retrieve a list of available shared and private reports, to present these...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-24T17:26:06+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/","name":"get_reports - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-24T17:26:06+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getreports-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Application Programming Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/"},{"@type":"ListItem","position":4,"name":"get_reports"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24251","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24251"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24251\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24223"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24251"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}