Document the data issues endpoints

01 Cloud Platform/09 Datasets/03 Data Issues/04 Report New Issues.html

@@ -14,4 +14,6 @@
     <li>Click <span class="button-name">Publish</span>.</li>
 </ol>
 
+<p>To report an issue programmatically, use the <a href="/docs/v2/cloud-platform/api-reference/data-issues/create-data-issue">Create Data Issue</a> endpoint of the REST API.</p>
+
 <p>History requests in live algorithms still use the historical datasets, so report issues with them as described above. The real-time stream comes from the data provider you select when you deploy, so the Data Issues page doesn't track it. If you encounter an issue with real-time data, first confirm that the <a href="/docs/v2/writing-algorithms/live-trading/data-providers">data provider</a> supports the asset. We recommend the <a href="/docs/v2/cloud-platform/datasets/quantconnect">QuantConnect data provider</a> as the first choice. If the issue persists, <a href="/docs/v2/cloud-platform/organizations/support#06-Open-New-Tickets">open a support ticket</a> and attach the project and the live deployment.</p>

01 Cloud Platform/99 API Reference/00.json

@@ -18,6 +18,7 @@
 	  "11" : "Generate reports for backtests to evaluate performance",
 	  "12" : "Read account information",
 	  "13" : "Read LEAN engine version",
+	  "15" : "Report and list data issues",
 	  "99" : "Examples of using the API with Jupyter Notebooks"
 	}
   }

01 Cloud Platform/99 API Reference/15 Data Issues/01 Create Data Issue/01 Introduction.html

@@ -0,0 +1,5 @@
+<!-- Code generated by API-Reference-Code-Generator.py -->
+
+<p>
+Report an issue with a dataset on the Data Issues page.
+</p>

01 Cloud Platform/99 API Reference/15 Data Issues/01 Create Data Issue/02 Description.html

@@ -0,0 +1,5 @@
+<!-- Code generated by API-Reference-Code-Generator.py -->
+
+<p>
+Every report must include a reproducible case, so our Data Team can reproduce the issue. Attach the project of a backtest or notebook that shows the issue with the <code>select-project</code> property and the backtest with the <code>select-backtest</code> property, or include a code snippet in the <code>content</code> property. Follow the <a href="/docs/v2/cloud-platform/datasets/data-issues#05-Best-Practices">best practices</a> when you write the report. Before you report an issue, use the <code>/community/data-library/issues/list</code> endpoint to check if an open issue already covers the same ticker and resolution.
+</p>

01 Cloud Platform/99 API Reference/15 Data Issues/01 Create Data Issue/03 Request.html

@@ -0,0 +1,96 @@
+<!-- Code generated by API-Reference-Code-Generator.py -->
+<p>
+The dataset, time window, and description of the issue. The <code>/community/data-library/issues/create</code> API accepts requests in the following format:
+</p>
+<table class="table qc-table">
+<thead>
+<tr>
+<th colspan="2"><code>CreateDataIssueRequest</code> Model - Request body to report a data issue.</th>
+</tr>
+</thead>
+<tr>
+<td width="20%">ticker</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: SPY</sub></i></code> <br/> Ticker of the security with the issue.</td>
+</tr>
+<tr>
+<td width="20%">security</td> <td> <code>string Enum<br/><i><sub>required</sub></i></code> <br/> Asset class of the dataset. Options : ['Equity', 'Equity Option', 'Index', 'Index Option', 'Future', 'Future Option', 'Forex', 'CFD', 'Crypto', 'Crypto Future']</td>
+</tr>
+<tr>
+<td width="20%">market</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: USA</sub></i></code> <br/> Market of the dataset. The valid markets depend on the asset class, as shown in the market dropdown on the Data Issues page.</td>
+</tr>
+<tr>
+<td width="20%">resolution</td> <td> <code>string Enum<br/><i><sub>required</sub></i></code> <br/> Resolution of the dataset. The valid resolutions depend on the asset class and market. Options : ['Tick', 'Second', 'Minute', 'Hour', 'Daily', 'Coarse Fundamental', 'Fine Fundamental', 'Margin']</td>
+</tr>
+<tr>
+<td width="20%">from-date</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: 2024-08-01</sub></i></code> <br/> First date of the issue, in YYYY-MM-DD format.</td>
+</tr>
+<tr>
+<td width="20%">to-date</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: 2024-08-02</sub></i></code> <br/> Last date of the issue, in YYYY-MM-DD format. The end of the time window must be after the start.</td>
+</tr>
+<tr>
+<td width="20%">from-time</td> <td> <code>string<br/><i><sub>example: 09:30</sub></i></code> <br/> Time of day the issue starts, in HH:MM format. Required for Second and Minute resolution when the time window is shorter than 7 days.</td>
+</tr>
+<tr>
+<td width="20%">to-time</td> <td> <code>string<br/><i><sub>example: 16:00</sub></i></code> <br/> Time of day the issue ends, in HH:MM format. Required for Second and Minute resolution when the time window is shorter than 7 days.</td>
+</tr>
+<tr>
+<td width="20%">corrupted-files</td> <td> <code>string Enum</code> <br/> Include to report files that can't be read. Include at least one issue type. Options : ['Corrupted Files']</td>
+</tr>
+<tr>
+<td width="20%">missing-points</td> <td> <code>string Enum</code> <br/> Include to report missing data points. Options : ['Missing Points']</td>
+</tr>
+<tr>
+<td width="20%">missing-files</td> <td> <code>string Enum</code> <br/> Include to report missing files. Options : ['Missing Files']</td>
+</tr>
+<tr>
+<td width="20%">wrong-values</td> <td> <code>string Enum</code> <br/> Include to report wrong values. Options : ['Wrong Values']</td>
+</tr>
+<tr>
+<td width="20%">listing-error</td> <td> <code>string Enum</code> <br/> Include to report a listing error. Options : ['Listing Error']</td>
+</tr>
+<tr>
+<td width="20%">split-error</td> <td> <code>string Enum</code> <br/> Include to report a split error. Options : ['Split Error']</td>
+</tr>
+<tr>
+<td width="20%">dividend-error</td> <td> <code>string Enum</code> <br/> Include to report a dividend error. Options : ['Dividend Error']</td>
+</tr>
+<tr>
+<td width="20%">name-mapping-error</td> <td> <code>string Enum</code> <br/> Include to report a ticker mapping error. Options : ['Name Mapping Error']</td>
+</tr>
+<tr>
+<td width="20%">content</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: SPY data is missing on 2024-08-01.</sub></i></code> <br/> HTML description of the issue.</td>
+</tr>
+<tr>
+<td width="20%">select-project</td> <td> <code>integer</code> <br/> Id of one of your projects to attach to the issue, so the Data team can see the code that shows the issue. To get your project Ids, use the <code>/projects/read</code> endpoint.</td>
+</tr>
+<tr>
+<td width="20%">select-backtest</td> <td> <code>string</code> <br/> Id of a backtest of the attached project to attach to the issue. Requires <code>select-project</code>. To get the backtest Ids of a project, use the <code>/backtests/list</code> endpoint.</td>
+</tr>
+<tr>
+<td width="20%">Example</td>
+<td>
+<div class="cli section-example-container"><pre>
+{
+  "ticker": "SPY",
+  "security": "Equity",
+  "market": "USA",
+  "resolution": "Tick",
+  "from-date": "2024-08-01",
+  "to-date": "2024-08-02",
+  "from-time": "09:30",
+  "to-time": "16:00",
+  "corrupted-files": "Corrupted Files",
+  "missing-points": "Missing Points",
+  "missing-files": "Missing Files",
+  "wrong-values": "Wrong Values",
+  "listing-error": "Listing Error",
+  "split-error": "Split Error",
+  "dividend-error": "Dividend Error",
+  "name-mapping-error": "Name Mapping Error",
+  "content": "SPY data is missing on 2024-08-01.",
+  "select-project": 0,
+  "select-backtest": "string"
+}</pre>
+</div>
+</td>
+</tr>
+</table>

01 Cloud Platform/99 API Reference/15 Data Issues/01 Create Data Issue/04 Responses.html

@@ -0,0 +1,46 @@
+<!-- Code generated by API-Reference-Code-Generator.py -->
+
+<p>
+The <code>/community/data-library/issues/create</code> API provides a response in the following format:
+</p>
+<h4>200 Success</h4>
+<table class="table qc-table">
+<thead>
+<tr>
+<th colspan="2"><code>CreateDataIssueResponse</code> Model - Response from reporting a data issue.</th>
+</tr>
+</thead>
+<tr>
+<td width="20%">discussionId</td> <td> <code>integer</code> <br/> Id of the new data issue. The issue page is https://www.quantconnect.com/datasets/issue/{discussionId}.</td>
+</tr>
+<tr>
+<td width="20%">success</td> <td> <code>boolean</code> <br/> Indicate if the API request was successful.</td>
+</tr>
+<tr>
+<td width="20%">errors</td> <td> <code>string Array</code> <br/> List of errors with the API call.</td>
+</tr>
+<tr>
+<td width="20%">Example</td>
+<td>
+<div class="cli section-example-container"><pre>
+{
+  "discussionId": 0,
+  "success": true,
+  "errors": [
+    "string"
+  ]
+}</pre>
+</div>
+</td>
+</tr>
+</table><h4>401 Authentication Error</h4>
+<table class="table qc-table">
+<thead>
+<tr>
+<th colspan="2"><code>UnauthorizedError</code> Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.</th>
+</tr>
+</thead>
+<tr>
+<td width="20%">www_authenticate</td> <td> <code>string</code> <br/> Header</td>
+</tr>
+</table>

01 Cloud Platform/99 API Reference/15 Data Issues/01 Create Data Issue/99 Examples.php

@@ -0,0 +1 @@
+<? include(DOCS_RESOURCES."/qc-api/examples/data-issues.php");?>

01 Cloud Platform/99 API Reference/15 Data Issues/02 List Data Issues/01 Introduction.html

@@ -0,0 +1,5 @@
+<!-- Code generated by API-Reference-Code-Generator.py -->
+
+<p>
+List the issues reported on the Data Issues page.
+</p>

01 Cloud Platform/99 API Reference/15 Data Issues/02 List Data Issues/02 Description.html

@@ -0,0 +1,5 @@
+<!-- Code generated by API-Reference-Code-Generator.py -->
+
+<p>
+The results are paginated. Use the <code>start</code> and <code>end</code> properties to select a range of issues and the <code>resultsFound</code> property of the response to get the total number of issues that match the filters. To get all the issues in one request, set <code>end</code> to a value greater than or equal to <code>resultsFound</code>.
+</p>

01 Cloud Platform/99 API Reference/15 Data Issues/02 List Data Issues/03 Request.html

@@ -0,0 +1,40 @@
+<!-- Code generated by API-Reference-Code-Generator.py -->
+<p>
+Filters and range of the data issues to list. The <code>/community/data-library/issues/list</code> API accepts requests in the following format:
+</p>
+<table class="table qc-table">
+<thead>
+<tr>
+<th colspan="2"><code>ListDataIssuesRequest</code> Model - Request body to list data issues.</th>
+</tr>
+</thead>
+<tr>
+<td width="20%">status</td> <td> <code>string Enum</code> <br/> Status group of the issues to list. Open issues are In queue, In progress, Waiting Review, or Waiting for Data Vendor. Closed issues are Resolved, Closed, or Cannot Be Resolved. The default value is open. Options : ['open', 'closed']</td>
+</tr>
+<tr>
+<td width="20%">start</td> <td> <code>integer</code> <br/> Index of the first issue to return. The default value is 0.</td>
+</tr>
+<tr>
+<td width="20%">end</td> <td> <code>integer<br/><i><sub>example: 20</sub></i></code> <br/> Index after the last issue to return. The default value is 20.</td>
+</tr>
+<tr>
+<td width="20%">search</td> <td> <code>string<br/><i><sub>example: SPY</sub></i></code> <br/> Ticker to filter the issues by. The ticker must match exactly, but the match isn't case-sensitive.</td>
+</tr>
+<tr>
+<td width="20%">subscribed</td> <td> <code>boolean</code> <br/> If true, list only the issues you're subscribed to.</td>
+</tr>
+<tr>
+<td width="20%">Example</td>
+<td>
+<div class="cli section-example-container"><pre>
+{
+  "status": "open",
+  "start": 0,
+  "end": 20,
+  "search": "SPY",
+  "subscribed": true
+}</pre>
+</div>
+</td>
+</tr>
+</table>