Sassie¶
Bases: SassieClient, FlowComponent
Sassie
Overview
Get Data from Sassie API.
Properties (inherited from Sassie)
.. table:: Properties :widths: auto
+--------------------+----------+-----------+----------------------------------------------------------------------+
| Name | Required | Summary |
+--------------------+----------+-----------+----------------------------------------------------------------------+
| domain | Yes | Domain of Sassie API |
+--------------------+----------+-----------+----------------------------------------------------------------------+
| credentials | Yes | Credentials to establish connection with Polestar site (user and password) |
| | | get credentials from environment if null. |
+--------------------+----------+-----------+----------------------------------------------------------------------+
| data | No | Type of data to retrieve (surveys, questions, jobs, waves, locations, clients) |
+--------------------+----------+-----------+----------------------------------------------------------------------+
| filter | No | List of filters to apply to the results. Each filter must have: |
| | | - column: The column name to filter on |
| | | - operator: One of: eq (equals), lt (less than), gt (greater than), |
| | | lte (less than or equal), gte (greater than or equal), btw (between) |
| | | - value: The value to compare against |
+--------------------+----------+-----------+----------------------------------------------------------------------+
| masks | No | A dictionary mapping mask strings to replacement strings used for |
| | | replacing values in filters. |
+--------------------+----------+-----------+----------------------------------------------------------------------+
Save the downloaded files on the new destination.
Example:
```yaml
Sassie:
domain: SASSIE_PROD_URL
data: locations
credentials:
client_id: SASSIE_CLIENT_ID
client_secret: SASSIE_CLIENT_SECRET
filter:
- column: updated
operator: eq
value: '{today}'
masks:
'{today}':
- today
- mask: '%Y-%m-%d'
```