GET report

Get info on an already created report.

Parameters

Parameters	Detail
with optional	Returns sub-object or count of sub-objects relating to the report. If sub-object is requested, response will return the first 20 records Accepted value: "member"
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for GET report

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/report

Access Permission

Requester must be an Admin. See Authentication for detail on authentication.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

URL: https://example.brightidea.comapi3/report/234

{
"report": {
    "id": "234",
    "top_id": "866144B1-E302-42EF-AF80-75DE988885AE",
    "member_id": "C893B9AF-0622-4568-B56F-77600DE1EFAC",
    "date_started": "2013-04-15 15:42:39.360",
    "date_completed": "2013-04-16 15:05:03.773",
    "campaign_id": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513",
    "report_type": "ideacommentdetails",
    "url": "https://{api_domain}/_report/download/234"
}
}

LIST report

Get info on a list of already created reports. Reports are order by started date descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters	Detail
id optional	Filter return by report ID Sample value: "45564"
date_started optional	Filter return by report started date. Response contains all reports started within the 24 hours of the specified date Sample value: "12/06/2009"
date_completed optional	Filter return by completed date. Response contains all reports completed within the 24 hours of the specified date Sample value: "12/06/2009"
campaign_id optional	Filter return by ID of campaign Sample value: "11111111-1111-1111-1111-111111111111"
member_id optional	Filter return by ID of member Sample value: "11111111-1111-1111-1111-111111111111"
report_type optional	Filter return by report type Sample value: "ideacommentdetails"
page_size optional	Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100 Sample value: 50
page optional	Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count} Sample value: 5
order optional	A SQL style string that specifies the order the records should return in Sample value: "date_started ASC, report_type DESC" Accepted attributes: "id", "report_code", "title", "date_created", "date_modified", "visible", "anonymous", score"
with optional	Returns sub-object or count of sub-objects relating to the member. If sub-object is requested, response will return the first 20 records Accepted value: "member"
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST report

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/report

Access Permission

Requester must be an Admin. See Authentication for detail on authentication.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

URL: https://example.brightidea.com/api3/report?page_size=2&page=4&order=date_started&with=member

{
"report_list": [
    {
        "id": "234",
        "top_id": "C893B9AF-0622-4568-B56F-77600DE1EFAC",
        "member_id": "866144B1-E302-42EF-AF80-75DE988885AE",
        "date_started": "2013-04-15 15:42:39.360",
        "date_completed": "2013-04-16 15:05:03.773",
        "campaign_id": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513",
        "report_type": "ideacommentdetails",
        "url": "https://{api_domain}/_report/download/234"
        "member": {
            "id": "866144B1-E302-42EF-AF80-75DE988885AE",
            "email": "jdoe@example.com",
            "screen_name": "John Doe",
            "first_name": "John",
            "last_name": "Doe",
            "job_title": "Sales",
            "address": "123 fake street",
            "phone": "(123) 456-789",
            "mobile_phone": "(987) 654-3210",
            "external_user_id": "",
            "skills": "Selling Software",
            "work_history": "Worked at sales.com",
            "photo_url": null,
            "date_created": "2013-03-07 19:09:54.563",
            "date_modified": "2013-04-16 14:36:57.613",
            "active": true
        }
    },
    {
        "id": "2326",
        "top_id": "C893B9AF-0622-4568-B56F-77600DE1EFAC",
        "member_id": "866144B1-E302-42EF-AF80-75DE988885AE",
        "date_started": "2013-06-15 15:42:39.360",
        "date_completed": "2013-06-16 15:05:03.773",
        "campaign_id": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513",
        "report_type": "ideacommentdetails",
        "url": "https://{api_domain}/_report/download/2326"
        "member": {
            "id": "8FA49B96-3693-4282-8919-014618D7B3B8",
            "email": "mpower@example.com",
            "screen_name": "Max Power",
            "first_name": "Max",
            "last_name": "Power",
            "job_title": "Safety Inspector",
            "address": "742 Evergreen Terrace, Springfield, IL",
            "phone": "(123)456-7890",
            "mobile_phone": "(987)654-3210",
            "external_user_id": "0072",
            "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic",
            "work_history": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber",
            "photo_url": "https://example.brightreporttest.com/api3/file/CCBCC6A7-98C9-48E1-92F3-0C05AAC78863?format=binary&thumb_size=100",
            "date_created": "2013-03-07 17:10:13.627",
            "date_modified": "2013-03-29 15:25:51.207",
            "active": true,
            "photo_file_id": "CCBCC6A7-98C9-48E1-92F3-0C05AAC78863",
        }
    }
],
"stats": {
    "total": "518",
    "page_count": 259,
    "current_page": 4
}
}

CREATE report

Create a report.

Parameters

Parameters	Detail
report_type required	This is the type of report. Sample value: "ideacommentdetails"
report_format required	This is the format of the report. Sample value: "csv"
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for detail on authentication.

HTTP Methods: POST

Request URL Format: https://{api_domain}/api3/report

Access Permission

Requester must be an Admin. See Authentication for detail on authentication.

Errors

Invalid report
Invalid value
Invalid report format

Example Request

Method: POST
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/report

Form data:

report_type=ideacommentdetails
report_format=csv

{
"report": {
    "id": "266",
    "date_started": "2013-04-16 15:42:39.050",
    "report_type": "ideacommentdetails",
    "top_id": "36E5A3B1-ECD9-48E4-8F43-FB6296F8A2E1",
    "member_id": "8FA49B96-3693-4282-8919-014618D7B3B8"
}
}

DELETE report

Delete a report.

Requester can delete his own submitted report.

Parameters

Parameters	Detail
id required	This is the ID of the report Sample value: "1695"
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for detail on authentication.
HTTP Methods: DELETE
Request URL Format: https://{api_domain}/api3/report

Access Permission

Requester can delete thier own report.

Errors

Invalid ID received

Example Request

Method: DELETE
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

URL: https://example.brightidea.com/api3/report

{
    "message": "success",
    "code": 200
}

GET reportDownload

Download an already created report.

Resource Information

Authentication: See Access Permission for GET report

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/reportDownload/{id}

Access Permission

Requester must be an Admin. See Authentication for detail on authentication.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/reportDownload/234

Code,Category,Submitted,Submitter,"Submitter email",Title,Description,Status,Stage,Step,Score,"Count of Comments","Number of Views","Tracked Outcomes","Projected Value","Associated Tags","Has Attachment?",Linked?,URL,"Previous Status","Date Idea Entered Current Status","Days In Current Status",Merged,"Merged With","Submitted From","Idea Image","External Idea Id" D5085,"Marketing & Branding","2017-01-23 18:00","Max Power",mpower@brightidea.com,"Max's awesome idea","Max's awesome idea ","In Design",Selection,Development,1,0,18,12345,0,,Yes,No,https://example.brightidea.com/ct/ct_a_view_idea.bix?c=F0E38889-7C92-4A2F-91A7-324F41FEFCD9&idea_id=04D8A745-D9CB-46AA-AAB9-0050AFE37F2F,New,2017-02-17,0,-,-,API3,https://example.brightidea.com/ct/getfile.php?c=F0E38889-7C92-4A2F-91A7-324F41FEFCD9&f=369E0488-F53C-46B8-B0C8-4D11C38678A1,