arcgis.apps.survey123 module¶

SurveyManager¶

class arcgis.apps.survey123.SurveyManager(gis, baseurl=None)¶

Bases: object

Survey Manager allows users and administrators of Survey 123 Surveys to analysis, report on , and access the data for various surveys.

get(survey_id)¶: returns a single Survey object from and Item ID or Item

property surveys¶: returns a list of existing Survey

Survey¶

class arcgis.apps.survey123.Survey(item, sm, baseurl=None)¶

Bases: object

A Survey is a single instance of a survey project. This class contains the Item information and properties to access the underlying dataset that was generated by the Survey form.

Data can be exported to Pandas DataFrames, shapefiles, CSV, and File Geodatabases.

In addition to exporting data to various formats, a Survey’s data can be exported as reports.

create_report_template()¶

The create_report_template creates a simple default template that can be downloaded locally, editted and uploaded back up as a report template.

Returns: string

download(export_format: str, save_folder: Optional[str] = None) → str¶

Exports the Survey’s data to other format

Argument	Description
export_format	Required String. This is the acceptable export format that a user can export the survey data to. The following formats are acceptable: File Geodatabase, Shapefile, CSV, and DF.
save_folder	Optional String. The full save path. This is optional.

Returns: string or pd.DataFrame

generate_report(report_template: arcgis.gis.Item, where: str = '1=1', utc_offset: str = '+00:00', report_title: Optional[str] = None, folder_id: Optional[str] = None) → str¶

Creates a MS Word Report. The generate_report method allows users to either save the report to the enterprise or export it directly to disk.

To save to disk, do not specify a report_title. This is the default behavior.

Argument	Description
report_template	Required Item. The report template Item.
where	Optional String. This is the select statement used to export part or whole of the dataset. If the record count is > 1, then the item must be saved to your organization.
utc_offset	Optional String. This is the time offset from UTC to match the users timezone. Example: EST - “+04:00”
report_title	Optional String. If provided, the report will persist on enterprise with the title of this name.
folder_id	Optional String. The folder ID of the user’s content.

Returns: Item or string

property properties¶: returns the properties of the survey

property report_templates¶

Returns a list of saved report items

Returns: list of Items

property reports¶: returns a list of generated reports