Giter VIP home page Giter VIP logo

demoseille's Introduction

locais.mobi

Analytics for Foursquare venue owners.

This is a work in progress project, this documentation does not imply all the existing features (for more or less).

Requirements

  • PHP >= 5.3.5
  • Respect (PHP Components)
    • Loader >= 0.2.0
    • Rest >= 0.4.1
    • Config >= 0.4.1
    • Relational >= 0.4.4
    • Validation >= 0.4.4
  • Twig >= 1.7.0

Installation

Point the web server to use the public folder as the Document Root. All requests must be redirected to the index.php file. If Apache is used, a .htaccess is already provided.

Below are the pear installation commands for the before mentioned dependencies:

sudo pear channel-discover respect.li/pear
sudo pear install Respect/Loader-0.2.0
sudo pear install Respect/Rest-0.4.1
sudo pear install Respect/Relational-0.4.4
sudo pear install Respect/Config-0.4.1
sudo pear install Respect/Validation-0.4.4
sudo pear channel-discover pear.twig-project.org
sudo pear install twig/Twig

API endpoints

A list of URIs identifying the availiable resources in the given supported formats:

  • text/html
  • application/json
  • text/xml
  • application/x-net.php.serialize.vnd

[GET/POST] /venues

List and search of venues.

Examples:

  • /venues?q=tribeca Lists venues that are managed by the current API with the given name

[GET] /venues/*

Shows basic information about an specific venue.

[GET] /venues/*/stats

Shows detailed statics about the given venue:

  • Total checkins
  • New chekeins
  • Unique visitors
  • Sharing (Facebook/Twitter)
  • Gender (Male/Female)
  • Age
  • Checkins per hour
  • Histogram
  • Tips
  • Photos

[GET] /venues/*/people

Shows detailed information from the given venue related to people.

  • Top people
  • Recent people
  • Unique people

[GET] /venues/*/people/*

Shows detailed information from the given venue related to a given person.

  • Checkin history
  • Tip history
  • Photo history
  • Comentary history
  • Related people

OBS: Information provided only since the crawling for that vendor started.

[GET] /venues/*/near

Shows information about near venues related to the given venue.

  • Similar audience
  • Similar venues
  • Same venue category
  • Popular venues

OBS: Information provided only since the crawling for that vendor started.

[GET] /venues/*/near/*

Shows information about a near venue related to the given venue.

  • Distance
  • Same people
  • Competing audience

OBS: Information provided only since the crawling for that vendor started.

[GET] /venues/*/snapshot

Basic information resuming what is provided by stats, near and people for the last hour.

OBS: Information provided only since the crawling for that vendor started.

License

Locais.mobi, Foursquare statistics for venue owners.
Copyright (C) 2012 Aeronautics

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Contact

If you feel like talking, you can reach us at:

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.