Skip to content
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.

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

Redesign the API user experience to reduce misuse and encourage people onto plans (release plan included) #1885

Open
JoannaHill opened this issue Aug 14, 2024 · 3 comments
Assignees
Labels

Comments

@JoannaHill
Copy link

JoannaHill commented Aug 14, 2024

What problem are we trying to solve?

  • Users are misusing and abusing the data they have access to (and getting very creative about it). This is mostly the people who are not on plans
  • Kat and Andy have spent 3 months reviewing API activity and manually trying to move users onto plans. The work is manual, high effort and low return

How might we try to address this?
Matthew, Andy and Jo discussed and agreed on a release plan:

  • Redesign API landing page to better explain product, it's potential, it's intentions and purpose
  • Introduce forms for people wishing to join a plan (instead of them emailing us)
  • introduce expiry to new keys (that are not on a plan)
  • Introduce expiry to old keys (that are not on a plan)
  • Review plans, segments to optomise income
  • Review agreements so we are better covered
@JoannaHill JoannaHill converted this from a draft issue Aug 14, 2024
@JoannaHill JoannaHill added the api label Aug 14, 2024
@JoannaHill JoannaHill self-assigned this Aug 14, 2024
@JoannaHill JoannaHill moved this from API section improvements to In progress in PlanningAlerts Kanban Aug 15, 2024
@JoannaHill JoannaHill assigned mlandauer and blikantt and unassigned JoannaHill Aug 15, 2024
@JoannaHill
Copy link
Author

JoannaHill commented Aug 26, 2024

Release plan:

Release 1 COMPLETE

  • Redesigned landing page
  • New Developer Documentation page
  • Move key to My Account area
  • Impose a time limit on all NEW keys

UPDATED 18-11-24:

Release 2 'Link trial to plan better'

  • Introduce automatic email reminders for trial keys
  • Show more prominently that trial has expired

Release 3

  • Improve landing page communications
  • Introduce custom forms for community grant and custom plan
  • Make sign up for standard plan fully self serve (contract and terms of service fully online)
  • make attribution more manditory, enforce a 6 week cut off else they get charged. Explain better why attribution is important.

At some point yet to be decided, we agreed to impose limit to all API keys that were gained prior to the new trial (Release #1). Before we do this we agreed to design and implement some reminder emails and a 'ask for an extended trial' feature (Github issue #1543)

At some point lets introduce automatic emails to people/orgs who sign up to plans (community or paid).

@JoannaHill
Copy link
Author

Release #1 complete and live.
https://www.planningalerts.org.au/api/howto

Beginning work on Release #2.

@JoannaHill
Copy link
Author

Option for user to ask for a second trial key.
Adding in reference to github issue #1543 which would weave well into all this new work. Mock ups ready for review.

@JoannaHill JoannaHill changed the title Redesign the API user experience to reduce misuse and encourage people onto plans Redesign the API user experience to reduce misuse and encourage people onto plans (release plan included) Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: In progress
Development

No branches or pull requests

3 participants