コンタクト

このAPIエンドポイントは、コンタクトが定義されているアカウントでのみ使用できます。 コンタクトは、現在のアカウントとプレゼンテーションを共有している他のアカウントです。 このオプションは、一部のCUSTOMサブスクリプションプランでのみご利用いただけます。詳細はお問い合わせください。

コンタクトリスト

Contacts APIは、統計ビューへのリンクを含む各コンタクトについての詳細を返します:

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

返される値 :

[
    {
        "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

    特定のフィールドとの完全一致によるコンタクトの検索: id, name, email,  例:

    # 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

    名前 (name)電子メール (email) のいずれかで特定のパターンを含むコンタクトを検索:

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

並び替え (Ordering) :

idname で並び替え:

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

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

コンタクトの詳細

特定のコンタクトの詳細は以下を参照:

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

返されるデータの例:

{
    "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"
}

コンタクトの統計

コンタクトの詳細ごとに統計URLが返されます。

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

特定の統計データへのURLのリストを返します:

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

上記のURLは説明のために使用されているダミーで、実際にアクセスしても動作しません。

Views statistics

指定された時間範囲でこのアカウントと共有されているプレゼンテーションビューの数を返します。

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

URLは日付範囲(last_year、last_month、last_week、years、this_month、this_year)でフィルタリングできます。 デフォルトは last_monthです:

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

上記のURLは説明のために使用されているダミーで、実際にアクセスしても動作しません

返される値の例 (date_range=this_year):

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

フィルタリング

フィルタリングは date_range パラメータで行うことができます。

使用できる値: last_year, last_month, last_week, years, this_month, this_year

デフォルト値: last_month

返される値は、選択した日付範囲のビューの累積数を定義する辞書のリストです。

例:last_week の場合は:

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

上記のURLは説明のために使用されているダミーで、実際にアクセスしても動作しません。

結果 :

[
  {
      "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
  }
]

コンタクト共有フォルダー (コンタクトと共有されるフォルダー)

コンタクトと共有されるフォルダーのリスト

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

ページングされた共有プレゼンテーションのデータのリストを返します:

[
    {
        "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"
    }
]

上記のURLは説明のために使用されているダミーで、実際にアクセスしても動作しません。

共有プレゼンテーション (共有されたプレゼンテーション)

特定の共有ファルダ―によって、コンタクトと共有されるプレゼンテーションのリスト

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

ページングされた共有プレゼンテーションのデータのリストを返します:

{
    "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"
        }
    ]
}

上記のURLは説明のために使用されているダミーで、実際にアクセスしても動作しません。

返される参照データ

  • count - 結果の数
  • nextprevious - 次/前のデータセットのURL
  • per_page - ページあたりの結果の数
  • results - 共有プレゼンテーションデータのリスト
    • id - 共有プレゼンテーションの一意のID
    • uid - プレゼンテーションのID
    • ovus_numberovus_folder パラメータで使用される番号
    • contents_url - プレゼンテーションコンテンツオブジェクト(2D画像, 360°プレゼンテーション, ORBITTOUR)へのリンク
    • statistics_url - 共有プレゼンテーションの詳細な統計情報へのリンク

共有プレゼンテーションコンテンツ

特定のプレゼンテーションのコンテンツオブジェクトのリストを返します。

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

出力例:

[
  {
      "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": ""
  }
]

共有プレゼンテーションの統計

特定の統計データのURLのリストを返します。

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

返されるURL は、以下の統計データのURL:countries, cities, referers, views

出力例:

{
    "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

日付範囲(last_week, last_month, years )でフィルターされます。例:

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

Referers

先月の結果が返されます:

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

Cities

日付範囲(last_week, last_month, years )でフィルターされます。例:

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

Views

日付範囲(last_weeklast_monthyears, this_monththis_year )でフィルターされます。例:

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

上記のURLは説明のために使用されているダミーで、実際にアクセスしても動作しません。