From ac47208e97a88e755a3c504211dc3da5c155addc Mon Sep 17 00:00:00 2001 From: Sonali Tanavade Date: Wed, 4 Sep 2024 15:55:26 +0200 Subject: [PATCH] refactor: remove words and phrases --- apiary.apib | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/apiary.apib b/apiary.apib index 15e42bf..f9e4a8c 100644 --- a/apiary.apib +++ b/apiary.apib @@ -7199,10 +7199,10 @@ curl \ + Response 200 (text/csv) - "Check ID","Check start time",Language,"Scorecard URI","File ID","Content reference","File path","File name","Content ID","Acrolinx Score","Acrolinx Score color","All issues",Words,Sentences,Target,"Target ID","Content group ID","Content group","User ID","Full name",Integration,"Integration version","Content profile","Custom field department","Custom field role","Custom field status","Clarity goal score","Consistency goal score","Correctness goal score","Inclusive language goal score","Scannability goal score","Terminology goal score","Tone goal score","Words and phrases goal score","Clarity goal issues","Consistency goal issues","Correctness goal issues","Inclusive language goal issues","Scannability goal issues","Terminology goal issues","Tone goal issues","Words and phrases goal issues" - "4265b702-9a69-38ca-bb45-bcad9ee7d910",2024-01-14T23:06:58Z,en,"api/v1/checking/scorecards/4265b702-9a69-38ca-bb45-bcad9ee7d910","9d38800b-89ae-396c-ae11-1de419f13a8f",Yak-1,,Yak-1,,35,red,20,1119,47,"Essentials English 2","2bd7dbcb-5510-4cdf-b054-0f275d3047c2",,,"96e79a50-97f9-3721-a755-0e9616c26a0b","AbcFull XyzName",webchecker,v1,"f5b8573c-e603-46d7-8af0-512d199d478b",developers,junior,draft,57,6,76,40,19,45,42,0,3,2,8,2,5,5,3,7 - "0521406f-ccf1-3acf-904a-7452766df8d7",2024-01-15T05:34:06Z,en,"api/v1/checking/scorecards/0521406f-ccf1-3acf-904a-7452766df8d7","77ad4993-80f1-31ec-9aef-1a33d2021a86",Su-22,,Su-22,,52,yellow,20,504,41,"Essentials English 2","2bd7dbcb-5510-4cdf-b054-0f275d3047c2","710eed98-732b-3668-8a67-f4294d9a7ff4",Wade,"96e79a50-97f9-3721-a755-0e9616c26a0b","AbcFull XyzName",webchecker,v1,"f5b8573c-e603-46d7-8af0-512d199d478b",developers,senior,draft,15,64,84,42,43,30,85,56,4,2,6,6,3,0,9,4 - + "Check ID","Check start time",Language,"Scorecard URI","File ID","Content reference","File path","File name","Content ID","Acrolinx Score","Acrolinx Score color","All issues",Words,Sentences,Target,"Target ID","Content group ID","Content group","User ID","Full name",Integration,"Integration version","Content profile","Custom field department","Custom field role","Custom field status","Clarity goal score","Consistency goal score","Correctness goal score","Inclusive language goal score","Scannability goal score","Terminology goal score","Tone goal score","Clarity goal issues","Consistency goal issues","Correctness goal issues","Inclusive language goal issues","Scannability goal issues","Terminology goal issues","Tone goal issues" + "4265b702-9a69-38ca-bb45-bcad9ee7d910",2024-01-14T23:06:58Z,en,"api/v1/checking/scorecards/4265b702-9a69-38ca-bb45-bcad9ee7d910","9d38800b-89ae-396c-ae11-1de419f13a8f",Yak-1,,Yak-1,,35,red,20,1119,47,"Essentials English 2","2bd7dbcb-5510-4cdf-b054-0f275d3047c2",,,"96e79a50-97f9-3721-a755-0e9616c26a0b","AbcFull XyzName",webchecker,v1,"f5b8573c-e603-46d7-8af0-512d199d478b",developers,junior,draft,57,6,76,40,19,45,42,3,2,8,2,5,5,3 + "0521406f-ccf1-3acf-904a-7452766df8d7",2024-01-15T05:34:06Z,en,"api/v1/checking/scorecards/0521406f-ccf1-3acf-904a-7452766df8d7","77ad4993-80f1-31ec-9aef-1a33d2021a86",Su-22,,Su-22,,52,yellow,20,504,41,"Essentials English 2","2bd7dbcb-5510-4cdf-b054-0f275d3047c2","710eed98-732b-3668-8a67-f4294d9a7ff4",Wade,"96e79a50-97f9-3721-a755-0e9616c26a0b","AbcFull XyzName",webchecker,v1,"f5b8573c-e603-46d7-8af0-512d199d478b",developers,senior,draft,15,64,84,42,43,30,85,4,2,6,6,3,0,9 + + Response 400 (application/json) { @@ -7341,7 +7341,6 @@ curl \ + Scannability goal score (number) - Score for the goal Scannability + Terminology goal score (number) - Score for the goal Terminology + Tone goal score (number) - Score for the goal Tone - + Words and Phrases goal score (number) -Score for the goal Words and Phrases + {NAME} goal issues (string) - Number of Issues found for the goal. The number of columns in the CSV file will correspond to the number of goal names. For example, if there are 10 goals, the CSV file will have 10 columns for custom fields. + Clarity goal issues (number) - Number of Issues found for the goal Clarity + Consistency goal issues (number) - Number of Issues found for the goal Consistency @@ -7350,7 +7349,6 @@ curl \ + Scannability goal issues (number) - Number of Issues found for the goal Scannability + Terminology goal issues (number) - Number of Issues found for the goal Terminology + Tone goal issues (number) - Number of issues found for the goal Tone - + Words and Phrases goal issues (number) - Number of issues found for the goal Words and Phrases + {NAME} metric score (string) - Metrics suffix by actual name. If there are 10 metrics, the CSV will have 10 columns for metrics suffix by name of the metric ## Get issues data [GET /api/v1/reporting/data/issues{?start,end}]