Giter Club home page Giter Club logo

status_page_dart's Introduction

Effective Dart Badge MIT License Badge

Status Page Dart

Use this package to consume Atlassian's Status Page API from Dart/Flutter.

Please refer to https://developer.statuspage.io for more info on the API.

Features

Initially we support the following functionality:

  • Get list of pages
  • Get specific page by id
  • Get list of components by page
  • Get component by id by page
  • Get list of incidents
  • Get page info and components summarized

In the following versions we'll be adding more more functionality

Getting started

API Key

First, you need to get your api key, to do this, enter Status Page website and go to API info section on your profile.

From here you can start using this package but we recommend to get couple other data.

Page Id

On the same page, you'll find your page id, it should look something like this:

image

Component Ids

Although you can get this using the package, it might be easier to get them from the web.

to do this, go to you components page and look at the url, there you'll find every component id refer to the following example:

https://manage.statuspage.io/pages/PAGE_ID/components/COMPONENT_ID/

Status Page Summary

You can get the summarized status page information of your page using the summary function.

You just need to send the page domain, which looks something like this example: status.example.app.

Usage

final statusPage = StatusPage(apiKey: 'YOUR_API_KEY');

final pages = await statusPage.pages;

final page = await statusPage.page('PAGE_ID');

final componentList = page.components;

final component = page.component('COMPONENT_ID');

final incidentList = await statusPage.incidents;

final unresolvedIncidents = await statusPage.incidents('PAGE_ID', IncidentType.unresolved);

final summary = StatusPage.summary(url: 'YOUR_DOMAIN_URL');

status_page_dart's People

Contributors

sk-dv avatar davemorales avatar dependabot[bot] avatar saentari avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.