Skip to content

Update to work with Zingtree API v1 #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dtf0 wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Update to work with Zingtree API v1 #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb8d317
Refactor: loop dispatch, urllib, error handling
dtf0 Jun 21, 2026
8d7e631
Align zinger with Zingtree API v1
dtf0 Jun 21, 2026
44e6a89
Update copyright information, add full Apache-2.0 licence to COPYING
dtf0 Jun 21, 2026
d43c36b
Bump requirements
dtf0 Jun 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 201 additions & 13 deletions COPYING
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,213 @@ Comment: This file documents the copyright statements and licenses for
For any copyright year range specified as YYYY-ZZZZ in this file, the
range specifies every single year in that closed interval.
Files: *
Copyright: © 2019 Dropbox, Inc.
Copyright: 2019-2020 Dropbox, Inc.
License: Apache-2.0

Files: ./zinger.py
Copyright: © 2019 Dropbox, Inc.
Files: ./zinger.py README.md
Copyright: 2019-2020 Dropbox, Inc.
Copyright: 2026 Dillon Feeney.
License: Apache-2.0

License: Apache-2.0
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

Copyright 2019 Dropbox, Inc.
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
1. Definitions.

http://www.apache.org/licenses/LICENSE-2.0
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
112 changes: 82 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,52 @@
# zinger
`zinger` is a command-line utility for modifying agents and retrieving session
information via the [Zingtree RESTful API](http://www.zingtree.com/api/).
`zinger` is a command-line utility for modifying agents, retrieving session
information, and querying trees via the
[Zingtree REST API (v1)](https://zingtree.com/api/).

## Getting started
### Config
Set up `.env` file at root if running from script, or configure `python-dotenv`
for your own script/program. You can use the `env_sample` and rename to `.env`
(with full-stop). Fill in your API token
Set up a `.env` file at root if running from script, or configure
`python-dotenv` for your own script/program. You can copy `env_sample` and
rename it to `.env` (with a full-stop). Fill in your API token. Alternatively,
execute `export ZINGTREE_API_TOKEN="..."`

Requests authenticate with the `X-Api-Key` header. You do not need to build it
yourself -- `zinger` reads `ZINGTREE_API_TOKEN` from `.env` and sets the header
on every call. The token never appears in the URL. The base URL is
`https://zingtree.com/api/v1/`.

`zingers.txt` should contain one agent config per line in the following format:
`[email@domain],[Forename Surname],[all tags separated by comma]`, example:

`zingers.txt` should contain one agent config per line in the following format: `[email@domain],[Forename Surname],[all tags separated by comma]`, example:
```
asummers@zingtree.com,Alice Summers,tag_0,tag_2
bwinters@zingtree.com,Bob Winters,tag_0,tag_1
```

### Requirements
- Python 3.9+
- `python-dotenv` (optional; only used to load `.env` -- if you don't use the
`.env` file, you must add `ZINGTREE_API_TOKEN` to your environment variables).

### Usage
Add it to your project's `lib/` or run `python3 zinger.py`. Make sure that you
Add it to your project's `lib/` or run `python3 zinger.py`. Make sure that you
have a text doc setup with the proper formatting. See "Config" section above.

## Supported endpoints
- `agent_add`
- Adds a no-login agent to your organisation, so access must be through SSO
or Google Authentication
- `agent_tag`
- Set or update comma-separated tags for an agent in your organisation
- `agent_remove`
- Removes an agent from your organisation
- `agent_sessions`
- Returns a JSON structure with session information for a particular agent
(if `-`, returns all agents) and date range in ISO-8601 format (if `null`,
returns last 30 days)
(if `*`, returns all agents) and date range in `YYYY-MM-DD` format (if
blank, returns last 30 days)
- `delete_file_upload`
- Deletes an uploaded file from the Zingtree servers, identified by folder
and file name
- `delete_form_data`
- Deletes any form data entered into Zingtree during a session
- `event_log`
Expand All @@ -46,47 +64,81 @@ have a text doc setup with the proper formatting. See "Config" section above.
- `get_session_notes`
- Returns a JSON structure with agent-entered notes from a session
- `get_tags`
- Returns a JSON structure with all tags used in your organisation's trees.
- `get_trees`
- Returns a JSON structure with information about all trees
- Returns a JSON structure with all tags used in your organisation's trees
- `get_tree_tag_all`
- Returns a JSON structure with trees that have ALL tags in CSV-format
- Returns a JSON structure with trees that have ALL tags in a comma-delimited
list
- `get_tree_tag_any`
- Returns a JSON structure with trees that have ANY tags in CSV-format
- Returns a JSON structure with trees that have ANY tags in a comma-delimited
list
- `get_tree_variables`
- Returns a JSON structure with the variables defined or used within a tree,
by tree ID
- `search_trees`
- Returns a JSON structure with information about all trees and nodes matching
query
the query. Separate terms with `^^` for an AND search
- `session_freeze`
- Freezes a session so it can no longer be resumed or shared. Issued as a PUT
with a `session_id` and `project_id` (tree ID). A resume attempt afterwards
starts a fresh session with a new ID
- `tree_sessions`
- Returns a JSON structure with session information for a particular tree and
date range in ISO-8601 format (if `null`, returns last 30 days)
- Returns a JSON structure with session information for a particular tree (if
`*`, returns all trees) and date range in `YYYY-MM-DD` format (if blank,
returns last 30 days)
- You can also use date and time (PST) instead of date. These would be like
YYYY-MM-DD HH:MM:SS. When calling a URL like this, replace the space
character with %20 (YYYY-MM-DD%20HH:MM:SS)
- `tree_sessions_last_clicked`
- As `tree_sessions`, but the date range applies to the time of the last
click rather than session start
- `vault_files`
- Retrieves or deletes a session Vault File by `file_uid`. A GET returns a
`download_url` valid for 60 seconds; a DELETE removes the file

## Misc
```
| Zingtree parameter | Zinger variable |
| ------------------ | --------------- |
| {{op}} ‡ | zt_oper |
| {{apikey}} ‡ | zt_token |
| {{agent login}} | zt_email |
| {{agent name}} | zt_name |
| {{tags}} | zt_tags |
| {{start date}} | zt_start |
| {{end date}} | zt_end |
| {{session ID}} | zt_session |
| Zingtree parameter | zinger input |
| -------------------- | ------------- |
| X-Api-Key (header) ‡ | token (.env) |
| {{agent login}} | email |
| {{agent name}} | name |
| {{tags}} | tags |
| {{tree ID}} | tree |
| {{session ID}} | session |
| {{file_uid}} | uid |
| {{folder}} {{file}} | folder, file |
| {{start date}} | start |
| {{end date}} | end |
```

‡ == required

Note: `count` returns 0 if operation runs into Schröd-zinger's agent
Notes:
- The operation is selected from the menu and encoded in the endpoint path; it
is no longer passed as an `op` parameter.
- For production sessions, append triple zeros (`000`) to the tree ID.
- There is a limit of 6000 API calls per day for each organisation.

Note: `count` returns 0 if operation runs into Schröd-zinger's agent.

---

## Licence
```
This project is libre and licenced APACHE-2.0; see the COPYING file or
https://www.apache.org/licenses/LICENSE-2.0 for more details.
Copyright 2019 Dropbox, Inc.
Copyright 2026 Dillon Feeney.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

---
Expand Down
3 changes: 1 addition & 2 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
pycurl==7.43.0.3
python-dotenv==0.10.3
python-dotenv>=1.2.2
Loading