Report

Owned by Caleb Burch (Unlicensed)
Last updated: Jun 09, 2014
3 min read
/report/{report_id}
Retrieves/Modifies a specific report, if no id is given updates the first report found for this user (currently users are only suppose to have 1 report so not sending an id is fine)
Possible Methods

GET POST PUT DELETE

Arguments

report_id(optional)
Report to modify

Json Object
{
        public String report_id;
    	public List<ReportDataPojo> report;
}

ReportDataPojo
{
	public int index;    
    public String note;
    public Date created_date;
	public String event_id;
	public String event_title;
	public String item_id;
	public String item_type; //should be "summary","analysis","feed", to determine how exporter draws these items, will default to just rendering whatever is there if item is analysis/other or null
	public String item_title; //field for UM to use for displaying headers in report
	public int event_index;
	public List<ReportDataItemPojo> data;
}

ReportDataItemPojo
{
	public String type; //e.g. duration/title/url/piechart/etc
    public String text;
    public String img;    
}
NSIGHT DATA ITEM EXAMPLES
//Feed item data:
{
...
"item_type":"feed",
"report_item_title":"", //n/a we don't show a header
"data":[
{"type":"title", "text":"Obama gives speech"},
{"type":"url","text":"http://www.cnn.com/article1"},
{"type":"description","text":"Obama gave a speech today in India, blah blha blha"},
{"type":"pub_date","text":"June 9th, 2014"}
]
}

//Analysis item data:
{
...
"item_type":"analysis",
"report_item_title":"Entity Type Sentiment (Mar 31 2014 - Mar 31 2014)",
"data":[
{"type":"EntSentFreqRelGraph", "text":"if theres a title or something", "img":"base64/img:asdf2343234sdfdsf"}
]
}

//Summary item data:
{
...
"item_type":"summary",
"report_item_title":"Fox News & Politics - Thematic Relations",
"data":[
{"type":"pub_date","text":"June 9th, 2014"},
{"type":"description","text":"Obama gave a speech today in India, blah blha blha"},
{"type":"duration", "text":"8 days", "img":"base64/img:asdf2343234sdfdsf"},
{"type":"documents", "text":"23", "img":"base64/img:asdf2343234sdfdsf"},
{"type":"location", "text":"Columbus, OH", "img":"base64/img:asdf2343234sdfdsf"},
{"type":"sentiment", "text":"2.67", "img":"base64/img:asdf2343234sdfdsf"}
]
}

 

Example
curl -b cookies.txt -X GET "http://localhost:8185/report" > response.txt
curl -b cookies.txt -X GET "http://localhost:8185/report/5331abfdb8e06221ba4a3b8a" > response.txt
curl -b cookies.txt -X POST -d '{"report":[{"index":0,"data":"88343","note":"nothing to see here", "created_date":"May 1, 2014 01:39:49 PM UTC"},{"index":1,"data":"asfd","note":"nothing to see here"}]}' "http://localhost:8185/report" > response.txt
curl -b cookies.txt -X PUT -d '{"report":[{"index":0,"data":"88343","note":"nothing to see here", "created_date":"May 1, 2014 01:39:49 PM UTC"},{"index":1,"data":"asfd","note":"nothing to see here", "event_id":"12345"}]}' "http://localhost:8185/report" > response.txt
curl -b cookies.txt -X DELETE "http://localhost:8185/report" > response.txt

 

Example Response
curl -b cookies.txt -X POST -d '{"report":[{"index":0,"data":"88343","note":"nothing to see here", "created_date":"May 1, 2014 01:39:49 PM UTC"},{"index":1,"data":"asfd","note":"nothing to see here", "event_id":"12345"}]}' "http://localhost:8185/report" > response.txt

 

 {
    "response": {
        "action": "Report",
        "success": true,
        "message": "Created a new report successfully",
        "time": 0
    },
    "data": {
        "report_id": "536401dc78ea6fd12b61222e",
        "report": [
            {
                "index": 0,
                "data": "88343",
                "note": "nothing to see here",
                "created_date": "May 1, 2014 01:39:49 PM UTC"
            },
            {
                "index": 1,
                "data": "asfd",
                "note": "nothing to see here",
                "created_date": "May 2, 2014 08:40:24 PM UTC", 
				"event_id":"12345"
            }
        ]
    }
}