Contacts

This API endpoint is only available for accounts that have some Contacts defined. Contacts are other Accounts that current Account can share presentations with. This option is only available for some CUSTOM subscription plans - contact us for details.

Contacts list

Contacts API returns details about each contact including link to views statistics:

URL: https://orbitvu.co/api/v1/contacts [.json|.xml]

Returned value:

[
    {
        "id": 1,
        "name": "ORBITVU",
        "email": "example@orbitvu.pl",
        "url": "https://orbitvu.co/api/v1/contacts/1/",
        "statistics_url": "https://orbitvu.co/api/v1/contacts/1/statistics",
        "shares_url": "https://orbitvu.co/api/v1/contacts/1/shares"
    },
    {
        "id": 2,
        "name": "ORBITVU 2",
        "email": "example+2@orbitvu.com",
        "url": "https://orbitvu.co/api/v1/contacts/2/",
        "statistics_url": "https://orbitvu.co/api/v1/contacts/2/statistics",
        "shares_url": "https://orbitvu.co/api/v1/contacts/2/shares"
    }
]

Searching:

  • exact

    Search for contacts by exact match to specific fields: id, name, email, eg.:

    # match contact with id == 1
    https://orbitvu.co/api/v1/contacts.json?id=1
    
    # match contact with email example@orbitvu.com
    https://orbitvu.co/api/v1/contacts.json?email=example@orbitvu.com
  • ilike - single

    Search for contacts containing specific pattern within one of name, email:

    # match all contacts with name or email containing 'A123' or 'a123'
    https://orbitvu.co/api/v1/contacts/?search=A123

Ordering:

Order by: id, name:

# ascending
https://orbitvu.co/api/v1/contacts/?ordering=id

# descending
https://orbitvu.co/api/v1/contacts/?ordering=-id

Contact details

Details of specific contact are available at:

URL: https://orbitvu.co/api/v1/contacts/<id>/ [.json|.xml]

Example data returned:

{
    "id": 1,
    "name": "ORBITVU",
    "email": "example@orbitvu.com",
    "url": "https://orbitvu.co/api/v1/contacts/1/",
    "statistics_url": "https://orbitvu.co/api/v1/contacts/1/statistics",
    "shares_url": "https://orbitvu.co/api/v1/contacts/1/shares"
}

Contact statistics

Statistics URL is returned for each contact details.

URL: https://orbitvu.co/api/contacts/<id>/statistics [.json|.xml]

Returns list of URLs to specific statistic data:

{
    "views": "https://orbitvu.co/api/v1/contacts/1/statistics/views"
}

URL shown above is for documentation purposes only and will not work if visited directly!

Views statistics

Returns number of presentation views shared with this account in specified time range

URL: https://orbitvu.co/api/v1/contacts/1/statistics/views

URL can be filtered by date ranges (last_year, last_month, last_week, years, this_month, this_year). The default is last_month:

https://orbitvu.co/api/v1/contacts/1/statistics/views?date_range=last_year

URL shown above is for documentation purposes only and will not work if visited directly!

Sample value returned (date_range=this_year):

[
  {
      "date": "01-2015",
      "views": 0.0
  },
  {
      "date": "02-2015",
      "views": 23.0
  }
]

Filtering

Filtering can be done with date_range parameter

Possible values: last_year, last_month, last_week, years, this_month, this_year

Default value: last_month

Returned value is a list of dictionaries defining cumulative number of views for the chosen date range, eg. for last_week it might be:

URL: https://orbitvu.co/api/v1/contacts/1/statistics/views/.json?date_range=last_week

URLs shown above is for documentation purposes only and will not work if visited directly!

Result:

[
  {
      "13-09-2014": 130
  },
  {
      "14-09-2014": 332
  },
  {
      "15-09-2014": 265
  },
  {
      "16-09-2014": 198
  },
  {
      "17-09-2014": 390
  },
  {
      "18-09-2014": 323
  },
  {
      "19-09-2014": 302
  }
]

Contact’s shared folders (folders shared with contact)

List of shared folders that are shared with contact

URL: https://orbitvu.co/api/v1/contacts/<id>/shares [.json|.xml]

Returns paginated list of shared presentations’ data:

[
    {
        "id": 1,
        "name": "Shared folder 1",
        "url": "https://orbitvu.co/api/v1/contacts/1/shares/1",
        "presentations_url": "https://orbitvu.co/api/v1/contacts/1/shares/1/presentations"
    },
    {
        "id": 2,
        "name": "Shared folder 2",
        "url": "https://orbitvu.co/api/v1/contacts/1/shares/2",
        "presentations_url": "https://orbitvu.co/api/v1/contacts/1/shares/2/presentations"
    }
]

URLs shown above is for documentation purposes only and will not work if visited directly!

Share's presentations (shared presentations)

List of presentations that are shared with contact by specific shared folder

URL: https://orbitvu.co/api/v1/contacts/<id>/shares/<shareid>/presentations [.json|.xml]

Returns paginated list of shared presentations’ data:

{
    "count": 1,
    "next": null,
    "previous": null,
    "per_page": 50,
    "results": [
        {
            "id": 5,
            "uid": "hnBuyqJMJEcTaTcivCVwdD",
            "ovus_number": "047",
            "contents_url": "https://orbitvu.co/api/v1/contacts/1/shares/1/presentations/5/contents",
            "statistics_url": "https://orbitvu.co/api/v1/shared/presentations/5/statistics"
        }
    ]
}

URLs shown above is for documentation purposes only and will not work if visited directly!

Returned data reference

  • count - a number of results
  • next, previous - URL to the next/previous dataset
  • per_page - number of results per page
  • results - list of shared presentation data
    • id - unique id of the shared presentation
    • uid - presentation identifier
    • ovus_number - number used in ovus_folder parameter
    • contents_url - link to presentation content objects (2D images, 360 degree presentation, ORBITTOUR)
    • statistics_url - link to detailed statistics of the shared presentation

Shared presentation contents

Returns list of content objects for specific presentation

URL: https://orbitvu.co/api/v1/contacts/<id>/shares/<shareid>/presentations/<presentationid>/contents [.json|.xml]

Sample output:

[
  {
      "id": 1,
      "name": "ov3601",
      "type": 1,
      "type_display": "ORBITVU 360",
      "ovus_folder": "https://orbitvu.co/047/hnBu2rJMJEcTaTcivCVwdD/ov3601/",
      "thumbnail_url": "//orbitvu.co/001/hnBu2rJMJEcTaTcivCVwdD/iproc/1/img01.png",
      "script_url": "//orbitvu.co/001/hnBu2rJMJEcTaTcivCVwdD/ov3602/3/script",
      "view_url": "//orbitvu.co/001/hnBu2rJMJEcTaTcivCVwdD/ov3602/3/view",
      "max_width": 5448,
      "max_height": 3589,
      "content2_xml": true
  },
  {
      "id": 2,
      "name": "img01.jpg",
      "type": 0,
      "type_display": "image",
      "ovus_folder": "",
      "thumbnail_url": "//orbitvu.co/001/hnBu2rJMJEcTaTcivCVwdD/iproc/1/img01.png",
      "script_url": "",
      "view_url": "//orbitvu.co/001/hnBu2rJMJEcTaTcivCVwdD/iproc/1/img01.png",
      "max_width": 0,
      "max_height": 0,
      "content2_xml": ""
  }
]

Shared presentation statistics

Returns list of URLs for specific statistics data

URL: https://orbitvu.co/api/shared/presentations/<presentationid>/statistics [.json|.xml]

Returned URLs are for statistics of: countries, sities, referers, views

Sample output:

{
    "countries": "https://orbitvu.co/api/v1/shared/presentations/5127/statistics/countries",
    "referers": "https://orbitvu.co/api/v1/shared/presentations/5127/statistics/referers",
    "cities": "https://orbitvu.co/api/v1/shared/presentations/5127/statistics/cities",
    "views": "https://orbitvu.co/api/v1/shared/presentations/5127/statistics/views"
}

Countries

Can be filtered by date_range of: last_week, last_month, years, e.g.:

https://orbitvu.co/api/v1/shared/presentations/5127/statistics/countries?date_range=last_week

Referers

Returns results for the last month:

https://orbitvu.co/api/v1/shared/presentations/5127/statistics/referers

Cities

Can be filtered by date_range of: last_week, last_month, years, e.g.:

https://orbitvu.co/api/v1/shared/presentations/5127/statistics/cities?date_range=last_week

Views

Can be filtered by date_range of: last_week, last_month, years, this_month, this_year eg.:

https://orbitvu.co/api/v1/shared/presentations/5127/statistics/views?date_range=last_week

URLs shown above is for documentation purposes only and will not work if visited directly!