Report Export API

Named Reports list

Report name
 		 Report name for endpoint
 
 Detailed Listing Data
 		  detailed_listing_data
 
 Detailed Prospect Data
 		  detailed_prospect_data
 
 Digital Access
 		  digital_access
 
 High-Level Metrics
 		  high_level_metrics
 
 Listing and Showing Metrics
 		  listing_and_showing_metrics
 
 Prospect Showing Data
 		  prospect_showing_data
 
 Listing Performance
 		  listing_performance
 

 Resident Information

 

 resident_information

 

JSON format example

Basics

Endpoint: https://showmojo.com/api/v3/reports/report_name_for_endpoint

Request method: POST

Authentication:

Note: If you are a master account user, pass "acting_as_master_account=true" parameter to the API request to indicate that you want to fetch the report data as a master account.

Pagination: The API does not support pagination.

cURL example

* Note that this example for Detailed Listing Data report. You should replace "detailed_listing_data" with any report name from table above.

Token based Authentication:

curl "https://showmojo.com/api/v3/reports/detailed_listing_data" -d "start_date=START_DATE&end_date=END_DATE" -vH 'Authorization: Token token="your_token"'

HTTP Basic Authentication:

curl "https://showmojo.com/api/v3/reports/detailed_listing_data" -d "start_date=START_DATE&end_date=END_DATE" -vu "your_login:your-password"

  • START_DATE, END_DATE : Supported formats include yyyy-mm-dd (2014-11-20) and yyyy-mm-dd HH:MM:SS (2014-11-20 19:30:21)
  • START_DATE and END_DATE are supported by all reports, except: Listing Performance report.
  • The dates in the request will be parsed in the timezone the account has been configured with.

CSV format example

Basics

Endpoint: https://showmojo.com/api/v3/reports/report_name_for_endpoint.csv

Request method: POST

Authentication:

cURL example

* Note that this example for Detailed Listing Data report. You should replace "detailed_listing_data" with any report name from table above.

Token based Authentication:

curl " https://showmojo.com/api/v3/reports/detailed_listing_data.csv" > OUTPUT_FILE.csv -d "start_date=START_DATE&end_date=END_DATE" -vH 'Authorization: Token token="your_token"'

HTTP Basic Authentication:

curl "https://showmojo.com/api/v3/reports/detailed_listing_data.csv" > OUTPUT_FILE.csv -d "start_date=START_DATE&end_date=END_DATE" -vu "your_login:your-password"

  • START_DATE, END_DATE : Supported formats include yyyy-mm-dd (2014-11-20) and yyyy-mm-dd HH:MM:SS (2014-11-20 19:30:21)
  • START_DATE and END_DATE are supported by all reports, except: Listing Performance report.
  • The dates in the request will be parsed in the timezone the account has been configured with.


Custom Reports

JSON format example

Basics

Endpoint: https://showmojo.com/api/v3/reports/custom

Request method: POST

Authentication:

cURL example

Token based Authentication:

curl "https://showmojo.com/api/v3/reports/custom" -d "report_id=REPORT_ID&start_date=START_DATE&end_date=END_DATE" -vH 'Authorization: Token token="your_token"'

HTTP Basic Authentication:

curl "https://showmojo.com/api/v3/reports/custom" -d "report_id=REPORT_ID&start_date=START_DATE&end_date=END_DATE" -vu "your_login:your-password"

  • START_DATE, END_DATE : Supported formats include yyyy-mm-dd (2014-11-20) and yyyy-mm-dd HH:MM:SS (2014-11-20 19:30:21)
  • The dates in the request will be parsed in the timezone the account has been configured with.

CSV format example

Basics

Endpoint: https://showmojo.com/api/v3/reports/custom.csv

Request method: POST

Authentication:

cURL example

Token based Authentication:

curl "https://showmojo.com/api/v3/reports/custom.csv" > OUTPUT_FILE.csv -d "report_id=REPORT_ID&start_date=START_DATE&end_date=END_DATE" -vH 'Authorization: Token token="your_token"'

HTTP Basic Authentication:

curl "https://showmojo.com/api/v3/reports/custom.csv" > OUTPUT_FILE.csv -d "report_id=REPORT_ID&start_date=START_DATE&end_date=END_DATE" -vu "your_login:your-password"

  • START_DATE, END_DATE : Supported formats include yyyy-mm-dd (2014-11-20) and yyyy-mm-dd HH:MM:SS (2014-11-20 19:30:21)
  • The dates in the request will be parsed in the timezone the account has been configured with.

 

Was this article helpful?