defaultheader

GET report {#get}

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 {#GetPermission}

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", "topid": "866144B1-E302-42EF-AF80-75DE988885AE", "memberid": "C893B9AF-0622-4568-B56F-77600DE1EFAC", "datestarted": "2013-04-15 15:42:39.360", "datecompleted": "2013-04-16 15:05:03.773", "campaignid": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513", "reporttype": "ideacommentdetails", "url": "https://{apidomain}/report/download/234" } } ~~~




LIST report {#list}

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: {pagecount}
Sample value: 5 order
optional |A SQL style string that specifies the order the records should return in
Sample value: "datestarted ASC, reporttype DESC"
Accepted attributes: "id", "reportcode", "title", "datecreated", "datemodified", "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 {#listPermission}

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

    ~~~ { "reportlist": [ { "id": "234", "topid": "C893B9AF-0622-4568-B56F-77600DE1EFAC", "memberid": "866144B1-E302-42EF-AF80-75DE988885AE", "datestarted": "2013-04-15 15:42:39.360", "datecompleted": "2013-04-16 15:05:03.773", "campaignid": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513", "reporttype": "ideacommentdetails", "url": "https://{apidomain}/report/download/234" "member": { "id": "866144B1-E302-42EF-AF80-75DE988885AE", "email": "jdoe@example.com", "screenname": "John Doe", "firstname": "John", "lastname": "Doe", "jobtitle": "Sales", "address": "123 fake street", "phone": "(123) 456-789", "mobilephone": "(987) 654-3210", "externaluserid": "", "skills": "Selling Software", "workhistory": "Worked at sales.com", "photourl": null, "datecreated": "2013-03-07 19:09:54.563", "datemodified": "2013-04-16 14:36:57.613", "active": true } }, { "id": "2326", "topid": "C893B9AF-0622-4568-B56F-77600DE1EFAC", "memberid": "866144B1-E302-42EF-AF80-75DE988885AE", "datestarted": "2013-06-15 15:42:39.360", "datecompleted": "2013-06-16 15:05:03.773", "campaignid": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513", "reporttype": "ideacommentdetails", "url": "https://{apidomain}/report/download/2326" "member": { "id": "8FA49B96-3693-4282-8919-014618D7B3B8", "email": "mpower@example.com", "screenname": "Max Power", "firstname": "Max", "lastname": "Power", "jobtitle": "Safety Inspector", "address": "742 Evergreen Terrace, Springfield, IL", "phone": "(123)456-7890", "mobilephone": "(987)654-3210", "externaluserid": "0072", "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic", "workhistory": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber", "photourl": "https://example.brightreporttest.com/api3/file/CCBCC6A7-98C9-48E1-92F3-0C05AAC78863?format=binary&thumbsize=100", "datecreated": "2013-03-07 17:10:13.627", "datemodified": "2013-03-29 15:25:51.207", "active": true, "photofileid": "CCBCC6A7-98C9-48E1-92F3-0C05AAC78863", } } ], "stats": { "total": "518", "pagecount": 259, "currentpage": 4 } } ~~~




CREATE report {#create}

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", "datestarted": "2013-04-16 15:42:39.050", "reporttype": "ideacommentdetails", "topid": "36E5A3B1-ECD9-48E4-8F43-FB6296F8A2E1", "memberid": "8FA49B96-3693-4282-8919-014618D7B3B8" } } ~~~




DELETE report {#delete}

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 {#getReportDownload}

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 {#GetPermission}

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/ctaviewidea.bix?c=F0E38889-7C92-4A2F-91A7-324F41FEFCD9&ideaid=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,