A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.intercom.com/docs/references/rest-api/api.intercom.io/data-export/getdataexport below:

Show content data export

Intercom API (2.14)

The intercom API reference.

Download OpenAPI description

The production API server The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Articles

Everything about your Articles

Away Status Reasons

Everything about your Away Status Reasons

Companies

Everything about your Companies

Conversations

Everything about your Conversations

Custom Channel Events

With the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

Data Attributes

Everything about your Data Attributes

Data Events

Everything about your Data Events

Data Export

Everything about your Data Exports

Data Export

The data export api is used to view all message sent & viewed in a given timeframe.

The identifier for your job.

Example: "orzzsbd7hk67xyu"

The current state of your job.

Enum"pending""in_progress""failed""completed""no_data""canceled"

Example: "pending"

download_expires_atstring

The time after which you will not be able to access the data.

Example: "1674917488"

The location where you can download your data.

Example: "https://api.intercom.test/download/messages/data/example"

{ "job_identfier": "orzzsbd7hk67xyu", "status": "pending", "download_expires_at": "1674917488", "download_url": "https://api.intercom.test/download/messages/data/example" }

Create content data export Request

To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data.

The only parameters you need to provide are the range of dates that you want exported.

🚧 Limit of one active job

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

❗️ Updated_at not included

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

📘 Date ranges are inclusive

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

Bodyapplication/json created_at_afterintegerrequired

The start date that you request data for. It must be formatted as a unix timestamp.

Example: 1527811200

created_at_beforeintegerrequired

The end date that you request data for. It must be formatted as a unix timestamp.

Example: 1527811200

curl -i -X POST \
  https://api.intercom.io/export/content/data \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "created_at_after": 1734519776,
    "created_at_before": 1734537776
  }'
Bodyapplication/json

The identifier for your job.

Example: "orzzsbd7hk67xyu"

The current state of your job.

Enum"pending""in_progress""failed""completed""no_data""canceled"

Example: "pending"

download_expires_atstring

The time after which you will not be able to access the data.

Example: "1674917488"

The location where you can download your data.

Example: "https://api.intercom.test/download/messages/data/example"

{ "job_identifier": "al9w983lwu88w1fd", "status": "pending", "download_url": "", "download_expires_at": "" }

Request

You can view the status of your job by sending a GET request to the URL https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.

🚧 Jobs expire after two days All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

Path job_identifierstringrequired

job_identifier

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X GET \
  'https://api.intercom.io/export/content/data/{job_identifier}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'
Bodyapplication/json

The identifier for your job.

Example: "orzzsbd7hk67xyu"

The current state of your job.

Enum"pending""in_progress""failed""completed""no_data""canceled"

Example: "pending"

download_expires_atstring

The time after which you will not be able to access the data.

Example: "1674917488"

The location where you can download your data.

Example: "https://api.intercom.test/download/messages/data/example"

{ "job_identifier": "braxwk3j039t6txy", "status": "pending", "download_url": "", "download_expires_at": "" }

Cancel content data export Path job_identifierstringrequired

job_identifier

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X POST \
  'https://api.intercom.io/export/cancel/{job_identifier}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'
Bodyapplication/json

The identifier for your job.

Example: "orzzsbd7hk67xyu"

The current state of your job.

Enum"pending""in_progress""failed""completed""no_data""canceled"

Example: "pending"

download_expires_atstring

The time after which you will not be able to access the data.

Example: "1674917488"

The location where you can download your data.

Example: "https://api.intercom.test/download/messages/data/example"

{ "job_identifier": "v134nyc2bku9hj91", "status": "canceled", "download_url": "", "download_expires_at": "" }

Download content data export Request

When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

📘 Octet header required

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

Path job_identifierstringrequired

job_identifier

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

curl -i -X GET \
  'https://api.intercom.io/download/content/data/{job_identifier}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'
Help Center

Everything about your Help Center

Internal Articles

Everything about your Internal Articles

Messages

Everything about your messages

News

Everything about your News

Notes

Everything about your Notes

Reporting Data Export

Everything about Reporting Data Export

Segments

Everything about your Segments

Subscription Types

Everything about subscription types

Teams

Everything about your Teams

Ticket States

Everything about your ticket states

Ticket Type Attributes

Everything about your ticket type attributes

Ticket Types

Everything about your ticket types

Tickets

Everything about your tickets

Visitors

Everything about your Visitors


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4